Mitel Client MiCollab Client Administrator Guide

Below you will find brief information for MiCollab Client Client. The MiCollab Client Client is a software-based solution that simplifies and enhances business communications, combining call control features from Mitel communication platforms with collaboration tools such as contact management, Dynamic Status, and instant messaging. This guide provides instructions on configuring and managing MiCollab Client on Mitel communication platforms, including features, specifications, installation, maintenance, and troubleshooting.

PDF Download

Document

MiCollab Client

ADMINISTRATOR GUIDE

Release 7.1

NOTICE

The information contained in this document is believed to be accurate in all respects but is not warranted by Mitel Networks™ Corporation (MITEL

). The information is subject to change without notice and should not be construed in any way as a commitment by Mitel or any of its affiliates or subsidiaries. Mitel and its affiliates and subsidiaries assume no responsibility for any errors or omissions in this document. Revisions of this document or new editions of it may be issued to incorporate such changes.

No part of this document can be reproduced or transmitted in any form or by any means - electronic or mechanical - for any purpose without written permission from Mitel Networks Corporation.

Trademarks

The trademarks, service marks, logos and graphics (collectively “Trademarks”) appearing on Mitel's

Internet sites or in its publications are registered and unregistered trademarks of Mitel Networks

Corporation (MNC) or its subsidiaries (collectively "Mitel") or others. Use of the Trademarks is prohibited without the express consent from Mitel. Please contact our legal department at [email protected]

for additional information. For a list of the worldwide Mitel Networks Corporation registered trademarks, please refer to the website: http://www.mitel.com/trademarks .

MiCollab Client Administrator Guide

Release 7.1

February 2016

®,™ Trademark of Mitel Networks Corporation

Table of Contents

Chapter 1 : Overview

Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

About This Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

Audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

Terminology . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

Features, enhancements, and changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

Overlapping DN support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

CSTA settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

Enabling or disabling TLS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

MiCollab MAC Desktop Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

MiCollab Web Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

MiCollab Client Deployment enhancements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

MiCollab for Mobile enhancements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

MiCollab Desktop Client enhancements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

Windows 10 support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

Headset support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

MiCollab corporate directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

MiVoice for Skype for Business Release1.2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

Click to Call . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

Duplicate DN support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Release 7.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

MiCollab for Mobile application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

MiCollab for Mobile simplified deployment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

MiVoice 5000 and MiVoice MX-One integration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

MiCollab Vidyo integration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

MiCollab corporate directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

Basic MiCollab Desktop Client and MiCollab Web Client enhancements . . . . . . . . . . . . . . . . . . 11

MiCollab Desktop Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

MiVoice for Skype for Business 1.1 SP3 enhancements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

Server and Client components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

MiCollab Client Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

MiCollab Desktop Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

MiCollab MAC Desktop Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

MiVoice for Skype for Business client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

MiCollab Web Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

MiCollab for Mobile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

Supported Communication Platforms (PBXs) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

Table of Contents

Mitel integrated applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

Optional third-party integrated applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

Documentation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

Chapter 2 : Features

Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

Server-Level features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

Federation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

Peering . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

Client interface features. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

MiCollab Desktop Client features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

MiCollab MAC Desktop Client features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

MiVoice for Skype for Business features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

MiCollab Web Client features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

MiCollab for Mobile features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

Communication platform features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

MiVoice Business features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

MiVoice Office 250 Communication platform features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

About Account Synchronization. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53

About Presence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54

Presence server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54

Presence modes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54

Types of presence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

Dynamic Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56

About Collaboration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

About SIP. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58

About OfficeLink . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59

PBX software requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59

Supported device types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60

OfficeLink functionality . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60

Basic Bundle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62

Entry Bundle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63

Teamwork Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65

Table of Contents

MiCollab Client for VMware Horizon view . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66

Chapter 3 : Specifications

Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70

System requirements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70

PBX requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70

About virtualization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72

Mitel Integrated Application requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73

MiCollab Desktop Client requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73

MiCollab MAC Desktop Client requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75

MiCollab Web Client requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75

MiCollab for Mobile for requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76

MiVoice for Skype for Business requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76

Optional third-party client components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77

PBX node environments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78

Chapter 4 : Installation and Configuration

Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80

Planning considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80

High level installation and configuration procedures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81

Configure the PBX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83

MiVoice Business PBX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83

User Configuration form . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84

License and Option Selection form . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84

Class of Service Options form . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84

Personal Ring Group Assignment form . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85

SIP Softphone settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85

MiVoice Office 250 PBX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85

Software license . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87

System – devices and feature codes – Assistants . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87

System – devices and feature codes – Phones . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87

(Softphones Only) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88

System – Sockets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88

Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88

MiVoice MX-One PBX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89

Configure integrated applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90

MiCollab UM configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90

iii

Table of Contents

Visual Voice Mail for Peered MiCollab Client Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90

MiCollab configuration options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91

FCOS options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91

Port utilization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91

Other Voice Mail systems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92

MiCollab Audio, Web and Video Conferencing configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92

MiVoice Border Gateway and Remote Proxy Services configuration . . . . . . . . . . . . . . . . . . . . . . . . 93

MiCollab Client and Ignite integration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94

Enabling Hot Desking for Ignite Agents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95

Install and configure MSL and MiCollab Client Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96

Software installation options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96

Install the MSL operating system . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97

Configure MSL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97

Install the MiCollab Client Service blade . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99

Verify MiCollab Client Service licensing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100

Install the MiCollab Client Virtual Appliance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100

Install and configure MiCollab Client softphone for VMware Horizon View . . . . . . . . . . . . . . . . . . 101

Configure user options MiCollab Client for VMware Horizon View . . . . . . . . . . . . . . . . . . . . . . . . 103

Access the MiCollab Client Service administration page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106

Provision MiCollab Client. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107

Install the MiCollab Desktop Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109

Software distribution point . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109

User installation permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109

Client firewalls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109

Welcome E-mail message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110

MiCollab Client Deployment E-mail message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110

Microsoft .NET framework . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111

Installation procedure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111

Custom installation options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112

IntelliMirror . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112

Logon Script . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113

SMS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113

Group policy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113

Citrix deployments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113

Installer transforms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114

Creating a transform . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115

Installer properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117

Table of Contents

Install MiVoice for Skype for Business Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118

Deploy MiCollab for Mobile Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120

Remote User Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120

MiVoice Business PBX Configuration for remote users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121

MiCollab Desktop Client softphone and teleworker settings . . . . . . . . . . . . . . . . . . . . . . . . . . . 121

MiVoice Office 250 PBX configuration for remote users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124

Softphone (SIP-based) specific considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124

Softphone Configuration - MiCollab Desktop Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127

Teamwork mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130

Server Admin portal impacts and considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130

Google Calendar Integration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133

Authentication and access to Google Calendar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133

Changes to clients . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135

Google contacts integration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137

Authentication and access to Google contacts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137

Chapter 5 : Maintenance

About software upgrades. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140

MiCollab Client software upgrades . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140

Upgrade UC server version 4.0, 4.1, 5.0 or 5.1 to MiCollab

Client Service version 7.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140

Upgrade UC Server version 6.0 to MiCollab Client Service version 7.0 . . . . . . . . . . . . . . . . . . 141

Upgrade Virtual MiCollab Client Service (vMiCollab Client) . . . . . . . . . . . . . . . . . . . . . . . . . . . 142

Upgrade the MiCollab Desktop Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143

Upgrades from v6.x . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143

Upgrade MiVoice for Skype for Business Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143

Client only delivery. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144

User upgrades (stand-alone to integrated) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144

MSL Server Administration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146

MiCollab Client Service Administration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146

Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146

Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146

Diagnostics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147

MiCollab Client Service Chat maintenance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154

Disable chat storage on server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154

Delete existing chat history from server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154

MiCollab Client Administrator Guide

MiCollab Desktop Client maintenance. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155

Install custom options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155

Repair the MiCollab Desktop Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156

Uninstall the MiCollab Desktop Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157

PBX configuration changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158

Chapter 6 : Troubleshooting

Server troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160

Installation problems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160

Server synchronization error messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160

MiCollab Client Service synchronization messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161

AD/LDAP synchronization error messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161

PBX node synchronization error messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162

Collaboration server synchronization message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163

Alarms/Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164

SIP connection event messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164

Presence event messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165

SIP Registrar event messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165

Watchdog messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166

MiTAI error codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166

Server log files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167

AD/LDAP synchronization log file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169

Domain synchronization summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170

Account totals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171

License and PBX changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172

Account reactivation following license changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172

Calendar integration troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173

Failure to successfully connect to the Exchange or Office 365 server . . . . . . . . . . . . . . . . . . . 173

Google calendar integration error after database backup and restore or MSL upgrade . . . . . . 174

MiCollab Desktop Client troubleshooting. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175

Problem reporting tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175

Additional Client log files and troubleshooting tools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176

MiCollab Desktop Client troubleshooting table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177

MiCollab Desktop Client error and warning messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180

Initialization messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181

Configuration change messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182

Teleworker setup message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183

File sending message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183

Table of Contents

ACD messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183

PIM integration messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183

Audio problems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185

Video problems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187

Device error . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187

MiVoice for Skype for Business troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188

Web Portal troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189

Android Device troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190

BlackBerry device troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191

MiCollab for Mobile for BlackBerry secure connections. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192

Access point name settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193

Transport layer security settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193

MiCollab Client for VMware Horizon View troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195

MiCollab Audio, Web and Video Conferencing collaboration troubleshooting. . . . . . . . . . . . . . . . . . . 196

vii

MiCollab Client Administrator Guide viii

Chapter 1 Overview

MiCollab Client Administrator Guide

Introduction

Mitel

MiCollab Client

converges the call control capabilities of Mitel communications platforms with contact management, Dynamic Status, and collaboration to simplify and enhance communications.

As a MiCollab Client administrator, you will be accessing the MiCollab Client Service to configure and manage MiCollab Client. MiCollab Client Service provisions users with MiCollab Client features and provides communication paths to the Private Branch Exchange (PBX) telephone system, voice mail, collaboration server, and other integrated applications.

Users access MiCollab Client features from the following interfaces:

• MiCollab Desktop Client

• MiCollab MAC Desktop Client

• MiVoice for Skype for Business

• MiCollab Web Client

• MiCollab for Mobile

• Android™

• BlackBerry

• iPhone™

• Windows Phone

Notes:

• The MiCollab for Mobile Softphone is designed for use on mobile phones. Although it can be installed on tablet devices, the user interface is currently not designed for use on tablets.

These devices will be supported in an upcoming release.

• MiCollab Client functionality described in documentation refers to enterprise as a single company entity. In scenarios where multiple server domains are created, it is understood to be within a single company environment where multiple MiCollab Client Services or mixed PBX nodes are required to manage the solution.

About This Guide

This administrator guide contains information about configuring MiCollab Client on a Mitel communications platform, and is organized as follows:

•

Overview

•

Features

•

Specifications

•

Installation and Configuration

•

Maintenance

•

Troubleshooting

Overview

Audience

This document is intended for MiCollab Client and network administrators. This administrator guide assumes that you are familiar with the system administration interfaces for the PBX platform you are connecting to. It also assumes that your MiCollab Client site has already purchased MiCollab

Client and the necessary MiCollab Client, PBX, and integrated application hardware, software, and licenses. Review the Release Notes before installing MiCollab Client.

This document is intended for MiCollab Client standalone installations; if you are working with

MiCollab Client integrated with MiCollab, see the MiCollab documentation suite.

Note:

This document assumes that the MiCollab Client administrator and the MSL administrator are the same person.

Terminology

The following terms are used throughout this guide:

• The term PBX (Private Branch Exchange) refers to the communication platform that MiCollab

Client is connected to. See

“Supported Communication Platforms (PBXs)” on page 16 for more

information about supported Mitel PBXs.

• The term PIM (Personal Information Manager) refers to a supported PIM application (for example, Google

Contacts, Microsoft

Outlook

or IBM

Lotus Notes

). See “Optional third-party integrated applications” on page 17 for a list of supported PIMs.

• The term softphone refers to the software-based IP or SIP phone that is available with the

MiCollab Desktop Client and MiCollab for Mobile clients.

• The term desk phone refers to the physical phone on the user’s desk that is controlled by

MiCollab Client.

• The term peering refers to the server configuration where MiCollab Client Service is connected to and communicating with another MiCollab Client Service and contacts for both servers are visible in the respective MiCollab Desktop Client applications. Contact-related features are accessible to all peered servers.

• The term federation refers to the server configuration where the MiCollab Client Service Extensible Messaging and Presence Protocol (XMPP) server is connected to and communicating with an external Instant Messaging (IM) XMPP server for the purposes of sharing IM presence and providing IM features.

• The product names VMware View and VMware Horizon View are used interchangeably throughout this guide. These are trademarks of VMware Incorporated.

MiCollab Client Administrator Guide

Features, enhancements, and changes

This MiCollab Client Administrator Guide was last published as Issue 7.0. This section provides information about the features, enhancements and changes included in the MiCollab Client 7.1 release.

Overlapping DN support

MiCollab Client allows two or more user accounts with MiNET softphones to have the same DN on

MiVoice Business implementations. A random, unique MAC address is generated for each MiNET softphone, allowing the same DN to be used on multiple MiVoice Business platforms connected through a shared MBG.

To avoid issues with previous releases of MiCollab Desktop Client, it is recommended users upgrade to the latest version.

Note the following:

• MAC addresses are generated for MiNET softphones only. In the case of deskphones and SIP softphones, the MAC address is blank.

• If the generated MAC address conflicts with an existing MAC address, you will be notified and the softphone is not provisioned.

• The MAC address is not generated for existing users with Minet softphones.

• When upgrading to Release 7.1, the MAC address is not generated for existing softphones.

• You can assign MAC addresses to existing softphones as required.

• When in co-located or standalone mode, you need to update the MAC address on MiCollab

Client, MiVoice Business and MBG manually.

• If there are changes to the MAC address for existing users, they need to upgrade MiCollab

Desktop Client while registering via MBG.

• If the MAC address is configured or updated while the user is logged in, they need to restart

MiCollab Desktop Client.

See MiCollab Client Administrator help for more information.

CSTA settings

When MiCollab Client is integrated with MiCollab and MiVoice MX-One or MiVoice 5000, you can configure the CSTA settings in MiCollab Client configuration. Administrators for standalone MiCollab

Client deployments will not see the associated fields.

See MiCollab Client Administrator help, PBX Nodes topic.

Enabling or disabling TLS

Enable or disable TLS in MSL configuration.

Overview

MiCollab MAC Desktop Client

MiCollab Client 7.1 introduces the MiCollab MAC Desktop Client. The MiCollab MAC Desktop Client is deployed to users through MiCollab Client Deployment administration. A deployment e-mail with installation and login information is sent to users.

[insert screen capture when available]

See Table 4, “MiCollab MAC Desktop Client UI features,” on page 36 for a list of supported features.

See “Basic Bundle” on page 62 and

“Entry Bundle” on page 63 for licensing information.

MiCollab Web Client

MiCollab Web Client has been redesigned for ease of use. It is supported on the following browsers:

• Apple Safari version 9

• Internet Explorer version 9, 10, or 11

• Google Chrome version 46 or higher

• Microsoft Edge

• Mozilla® Firefox® version 41 or higher

[insert screen capture when available]

See Table 6, “MiCollab Web Client UI features,” on page 40

for a list of supported features.

MiCollab Client Deployment enhancements

You can now load the default subject line and e-mail body for the deployment e-mail.

See MiCollab Client Deployment help for more information.

MiCollab for Mobile enhancements

The MiCollab for Mobile application has been enhanced with the following features:

• Long tap on a search result provides a dialog box allowing the user to select the device used to establish a call.

• Windows 10 support

• Call Forward

• Auto Answer with softphone

• In/out group

• Hotkey dialing

• Video call and presence

MiCollab Client Administrator Guide

• Call forward configuration: users can configure call forward settings based on their Dynamic

Status

Note: The following must be true in order for users to make use of this feature:

• MiCollab Client is connected to the MiCollab server

• PBX supports call forwarding

• Target number for the rule is valid

• MiVoice Office 250 support

MiCollab Desktop Client enhancements

Windows 10 support

MiCollab Client is supported in a Windows 10 environment.

Headset support

MiCollab Desktop Client supports accept, end, and mute call with approved Plantronics

SpokesWrapper 3.x SDK headsets and approved Jabra Connect desktop client headsets. Refer to www.Plantronics.com and www.Jabra.com for more information on supported models.

MiCollab corporate directory

MiCollab Client now supports 40,000 contacts in the corporate directory with eight peered servers.

See MiCollab Client Engineering Guidelines for capacity information.

MiVoice for Skype for Business Release1.2

Click to Call

Click to Call allows users to highlight a number in an open document and enter a hot key shortcut to make a call from MiCollab Desktop Client. The hot key is a combination of the Ctrl button and a hot code selected from a pulldown menu.

Enable and customize the Click to Call feature in Settings, General in MiVoice for Skype for

Business.

By default this feature is disabled.

Supported applications:

• Internet Explorer 2010 and later

• Google Chrome 33.x

• Mozilla Firefox

• Windows 7 Notepad

• Microsoft Excel 2013

• Microsoft Outlook 2013

Overview

• Microsoft Word 2013

Duplicate DN support

MiVoice for Skype for Business supports duplicate DNs in MiVoice MX-One and MiVoice 5000 integrations, allowing users to have the same DN for their softphone and deskphone. Users can now select which device to use to place calls.

Release 7.0

MiCollab for Mobile application

MiCollab 7.0 introduces MiCollab for Mobile, a new, simplified user application for mobile devices.

MiCollab UC-Client Release 6.1 (previously named MiCollab Mobile Client), is still available with

MiCollab 7.0.

Figure 1: MiCollab for Mobile application

The MiCollab for Mobile application is available for the following devices:

• BlackBerry 10.3 or later

• Google™ Android™ 5.0 or later

• iPhone iOS Version 8, 8.1, 8.2, 8.3, 9.0 or later

• Windows Phone 8.0, 8.1, 8.2, 8.3 or later

Note:

The MiCollab for Mobile Client Softphone is designed for use on mobile phones. Although it can be installed on tablet devices, the user interface is currently not designed for use on tablets. These devices will be supported in an upcoming release.

MiCollab Client Administrator Guide

The MiCollab for Mobile application is represented on mobile devices by the following icon:

In MiCollab Release 7.1 and later, MiCollab Client for Mobile softphones support Domain Name

System (DNS)-based SIP resiliency with MiVoice Border Gateways. See the MiCollab Client for

Mobile Resiliency Guide for more information.

MiCollab UC-Client is still available for the following devices:

• BlackBerry® v4.5, v4.6, v4.7, v5.0, v6.0 and v7.0

• Google™ Android™, 4.0, 4.1, 4.2, 4.3, and 4.4, 5.0 or later

• iPhone and iPad iOS Version 6.0, 7.0, 8.0, 8.1, 8.2, 8.3, 9.0 or later

The MiCollab UC-Client application is represented on mobile devices by the following icon:

For more information, see See “MiCollab UC-Client Application” on page 203.

Group Presence feature

The MiCollab for Mobile application allows the members of call groups to make themselves absent or present in a group from the MiCollab for Mobile application.

This feature is supported on MiVoice Business only. The feature supports:

• Ring and Hunt Groups

• Local and resilient remote groups

MiCollab for Mobile users can:

• Get Group List (Ring and Hunt Groups)

• Update group presence (Present/Absent)

Note:

The Group Presence Control COS option must be enabled for extensions on MiVoice Business for this feature to work.

For more information, see MiCollab Client Administrator help.

Overview

MiCollab for Mobile simplified deployment

MiCollab Client 7.0 introduces a new blade which allows for the simplified deployment of MiCollab for Mobile. This solution is supported in integrated and co-located MiCollab Client deployments.

Note:

A trusted third party Secure Sockets Layer (SSL) web certificate is required for MiCollab Client deployment. Secure Sockets Layer (SSL) is an encryption technology that creates a secure connection between a web server and a client's web browser. Information that is transmitted must be encrypted to prevent security issues such as eavesdropping or data tampering. An SSL web certificate is purchased from a Certificate Authority and installed on the web server to enable encryption. SSL encryption is required between the MiCollab servers and MiCollab for Mobile phone users because sensitive user information and configuration data is transmitted during the deployment of the clients. The SSL web certificate ensures that the MiCollab for Mobile clients establish secure connections during deployment.

Refer to the MiCollab Client Deployment help for instructions.

End users are no longer required to enter configuration settings such as server and SIP credentials.

Administrators configure these settings and MiCollab for Mobile clients are deployed Over the Air

(OTA). The administrator portal enables administrators to:

• deploy large groups

• leverage profiles

• download multiple files to the clients

• update clients

A new, customizable deployment e-mail with end user credentials is sent to MiCollab for Mobile users.

Note:

The first time you log into MiCollab Client Deployment, connect MBGs for user import before importing user records. Go to Configuration, Connections to MBGs.

If you change a user’s ID, you need to factory reset and redeploy the MiCollab for Mobile application. A new deployment e-mail needs to be sent to the user.

SIP transport protocol considerations for Android devices

Some versions of the Android OS do not allow large SIP packets from being sent to port 5060 when the SIP transport protocol is configured as TCP. To prevent this issue, set the SIP transport protocol to UDP or TLS. TLS directs all SIP traffic to port 5061 by default.

Go to MiCollab Client Deployment, Deployment Profiles, SIP transport protocol.

The list of known devices include the following:

• HTC One M7

• HTC One Mini 601n

• HTC One M8

• HTC One M9

MiCollab Client Administrator Guide

• HTC One X

• Sony Xperia Z

• Sony Xperia Z2

• Sony Xperia Z3

• Sony Xperia Z3 Compact

• Cat B15Q

• YotaPhone 2

Note:

Administrators may find it helpful to associate users with these devices in a separate deployment profile.

This list is subject to change. Please retrieve the latest version of this guide to ensure accuracy.

Migrating existing MiCollab UC-Client users to MiCollab for Mobile

If you are deploying MiCollab for Mobile to existing MiCollab UC-Client users, the users need to remove the MiCollab UC-Client application from their devices. When you deploy MiCollab for Mobile to these user accounts using MiCollab Client Deployment in MiCollab administrator programming, users receive a deployment e-mail with installation options.

If existing or new users have multiple devices, they need to install the client on each device.

For more information about simplified deployment configuration, see MiCollab Client

Deployment help.

For more information about MiCollab UC- Client deployment, see See “MiCollab UC-Client

Application” on page 203.

MiVoice 5000 and MiVoice MX-One integration

When deployed in a MiCollab environment, MiCollab Client can be integrated with MiVoice

5000 and MiVoice MX-One.

For more information, see MiCollab Installation Guide.

MiCollab Vidyo integration

MiCollab Desktop Client supports VidyoDesktop integration, allowing users to click an icon to join another user’s personal Vidyo Room.

Vidyo and MiCollab Audio, Web and Video Conferencing can be supported simultaneously.

MiCollab Desktop Client users can select the conference type.

Users with Vidyo integration supported receive their login information in their Welcome e-mail.

Note:

Vidyo integration is supported in MiCollab integrated mode only.

Overview

Vidyo administration is performed through the Vidyo portal. MiCollab supports the following Video components:

• Vidyo Portal / Router: Version 3.3.4

• Vidyo Gateway: Version 3.3.2

• Vidyo Desktop Client: Version 3.4 and 3.5

MiCollab Vidyo is part of UCC V3.1 licensing across all platforms supported with UCC licensing.

See Vidyo Integration Quick Reference Administrator Guide and the Vidyo Integration Quick

Reference User Guide.

MiCollab corporate directory

MiCollab Client now supports 20,000 contacts in the corporate directory with eight peered servers.

MiCollab Desktop Client loads the corporate directory during MiCollab Desktop Client startup. If the number of contacts in the corporate directory is more than preconfigured number on the server, the default view displays the Favorites and the Custom Group folders. If the number of contacts in the corporate directory is less than the preconfigured number on the server, the corporate directory contacts are stored locally.

MiCollab Desktop Client searches for contacts from the corporate directory and the favorite folders.

The search merges and displays the local contacts and the search results from server. For more information, see the MiCollab Client Administrator help.

Basic MiCollab Desktop Client and MiCollab Web Client enhancements

Basic MiCollab Desktop Client users and Basic and full MiCollab Web Client users can set their deskphones to Do Not Disturb, Call Forwarding and Auto Answer. When selected, these features apply to all user devices.

Note:

The Auto Answer feature is not supported on MiVoice 5000 and MiVoice MX-One. These integrations support Do Not Disturb and Call Forwarding for Basic MiCollab Desktop Client and

MiCollab Web Client.

The default user profile must be in use for these features to be available to basic level users. For more information, see

“Basic Bundle” on page 62 .

For a list of MiCollab Web Client features, see

“MiCollab Web Client features” on page 40

MiCollab Desktop Client

Upgrading Basic and Entry users

MiCollab Desktop Client 7.0 does not display Dynamic Status for users who do not have the Presence and Smart Status licensed features.

If a MiCollab Desktop Client 6.0 Basic or Entry user sets Dynamic Status to Do not Disturb with an associated Away availability and then upgrades their client to 7.0, the Dynamic Status cannot be changed by the user. The administrator needs to reset the Dynamic Status for the user.

MiCollab Client Administrator Guide

SIP credentials

MiVoice 5000 and MiVoice MX-One integrations: End users not using Teleworker mode, are no longer required to enter their SIP credentials in Softphone configuration.

Click to Call

Enable and customize the Click to Call feature in the Configuration dialog box in MiCollab Desktop

Client.

By default this feature is disabled.

Supported applications:

• Internet Explorer 2010 and later

• Google Chrome 33.x

• Mozilla Firefox

• Windows 7 Notepad

• Microsoft Excel 2013

• Microsoft Outlook 2013

• Microsoft Word 2013

This feature is supported on MiVoice Business, MiVoice Office, MiVoice MX-One and MiVoice 5000 platforms.

For more information, see MiCollab Desktop Client help file.

SSL certificate validation

MiCollab Desktop Client now performs SSL certificate validation. Note the following:

• If the SSL certificate cannot be validated, the user is prompted for confirmation. Once confirmed, the certificate is stored in the Windows certificate store under the name Mitel Trusted for use in future connections. Any change to the certificate results in MiCollab Desktop Client prompting the user for confirmation.

• If the certificate has expired, the user receives a popup message informing them of the expiration and that required functionalities, such as download peered contact picture from peered server and Vidyo conference, are not available from that server.

The message is displayed once. Further requests for access to that server are rejected silently.

• If no certificate is presented, the connection is rejected.

Note:

It is recommended you use a trusted certificate issued by third-party certificate authority for SSL.

Overview

To delete the certificate from the Windows store:

Type certmgr.msc in a command line window to open the Windows Certificate Store.

Open the Certificates folder under the Mitel Trusted folder.

Locate the certificate and select Delete.

Accented character support

You can enter accented characters in the MiCollab Client supported languages as follows:

Table 1: Accented Character Support

Field Compliance Remarks

First Name

Last Name

Password e-mail

UTF-8

ISO-8859-1

ASCII

Ordinal indicator characters are not displayed correctly in the first name and last name fields across MiCollab applications.

Limited to ISO-8859-1 characters.

The system derives the Login ID from the First Name and Last

Name fields. If either of these fields contains unsupported characters, the characters will be replaced with ISO-8859-1 characters.

Limited to ISO-8859-1 characters.

Limited to ASCII (non-accented) characters.

MiVoice for Skype for Business 1.1 SP3 enhancements

MiVoice for Lync has been renamed MiVoice for Skype

for Business.

MiVoice MX-One and MiVoice 5000 integration

MiVoice for Skype for Business can be integrated with MiVoice 5000 and MiVoice MX-One. Please note the following exceptions:

• AutoAnswer is not available with MiVoice 5000 and MiVoice MX-One

• Conditional forwarding is not available with MiVoice MX-One

Installation wizard - Default language selection

The installation wizard now prompts users to select the default language. For more information, see

“Install MiVoice for Skype for Business Client” on page 118 .

MiCollab Client Administrator Guide

Server and Client components

The MiCollab Client Service communicates with the phone system (see

“Supported Communication

Platforms (PBXs)” on page 16

) and other integrated applications (see

“Mitel integrated applications” on page 17

) to provide MiCollab Client features and functionality to the user interfaces.

The MiCollab Client product includes the MiCollab Client Service components and user interfaces described in this section.

MiCollab Client Service

The MiCollab Client Service software can reside as a stand-alone application on an MSL v10.3 or later approved hardware platform or as part of an integrated system with MiCollab, either on the physical server, or on VMware or Hyper-V. The MiCollab Client virtual appliance can be deployed in a VMware environment. See Virtual Appliance Deployment Solutions Guide.

MiCollab Client Service software components include:

• ADEPM: Manages Active Directory communication for account synchronization.

•

CSTAProxy: For MiVoice 5000 and MiVoice MX-One deployments only. Manages logging.

•

CTIMon:

• DSM: Analyzes accounts in the PBX database or Active Directory and maintains the account representation in the MiCollab Client Service.

• EPM: Manages MiXML-based communication with the MiVoice Business PBX for account synchronization.

• FEDERATIONGW: Handles the XMPP federation with third-party systems such as Skype for

Business, Google or IBM Lotus Sametime Server.

• IM: Handles Instant Messaging between Desktop Clients and provides page mode, conversation mode, and conference mode instant messages.

• JBoss: Provides the various administrator features and Web services.

• PbxProxy: Maintains MiTAI connections and receives call and feature events from the MiVoice

Business PBX. Publishes the events on the MiCollab Client Service internal message bus.

• Proxy5k: Maintains OAI connections and receives call and feature events from the MiVoice

Office 250 PBX. Publishes the events to the MiCollab Client Service internal message bus.

• Presence: Handles subscriptions and notifications for presence, calls, message waiting etc.

• RPS: Includes the server component for the MiCollab Client Service peered connection. This component “listens” on TCP port 36009 for incoming connection requests from the RTC component on a peered MiCollab Client Service.

• RTC: Includes the client component for the MiCollab Client Service peered connection. This component connects to the RPS component on a peered MiCollab Client Service.

• SEE: Provides the advanced call processing services such as preferential contact call routing.

• SIPProxy: Receives SIP messages from the network and routes them to the corresponding

MiCollab Client components, such as the SIP Registrar, Presence and IM.

Overview

• SIPRegistrar: Manages the SIP registrations from the MiCollab Desktop Client and notifies other

MiCollab Client components whenever registration is added or removed.

• Watchdog: Maintains and monitors other MiCollab Client Service components.

• WSP: Web Socket Proxy handles the connections from the MiCollab for Mobile for real-time notifications.

Administrators can provision, maintain, and troubleshoot MiCollab Client from the MiCollab Client

Service Administration interface.

The MiCollab Client Service software blade includes the client software for MiCollab Client. The following user interfaces provide access to MiCollab Client features:

•

“MiCollab Desktop Client” on page 15

•

“MiVoice for Skype for Business client” on page 16

•

“MiCollab Web Client” on page 16

The MiCollab Client Deployment blade includes the software for the MiCollab for Mobile application.

See “MiCollab for Mobile” on page 16

for more information.

Note:

Some MiCollab Client features require specific PBX software versions as detailed in the Notes column for the end-user feature tables starting on

page 31 .

MiCollab Desktop Client

MiCollab Desktop Client is an application that is installed on the user’s computer. MiCollab Desktop

Client allows users to control their desk phone and associated devices from their computer. MiCollab

Desktop Client includes an embedded softphone, providing users with two devices, if both are configured on the PBX. The softphone requires a separate license (see

Table 2 on page 22 .)

MiCollab Desktop Client requires the Microsoft.NET Framework (see

“MiCollab Desktop Client requirements” on page 73

). This component must be installed on the user’s computer prior to the installation of the MiCollab Desktop Client.

See “MiCollab Desktop Client features” on page 31 for a list of MiCollab Desktop Client features.

MiCollab MAC Desktop Client

MiCollab MAC Desktop Client is an application that is installed on the user’s computer. MiCollab

MAC Desktop Client allows users to control their desk phone and associated devices from their computer.

See “MiCollab MAC Desktop Client requirements” on page 75 for a list of MiCollab MAC Desktop

Client features.

MiCollab Client Administrator Guide

MiVoice for Skype for Business client

MiVoice for Skype for Business is an application that is installed on the user’s computer and integrates seamlessly with Skype for Business 2015, Lync 2010 and 2013 clients. It allows Skype for Business users to use Mitel telephony features through its feature rich MiCollab Client infrastructure.

Note:

MiVoice for Skype for Business is supported on MiCollab deployed MiCollab Client only.

MiCollab Web Client

The MiCollab Web Client interface provides remote access to a subset of MiCollab Client features from a Web browser on a computer or mobile device.

See

“MiCollab Web Client features” on page 40 for a list of Web Portal features.

MiCollab for Mobile

MiCollab for Mobile for is a stand-alone client that users install on their mobile device. The client provides Dynamic Status, access to call logs, messages, and corporate contacts. To install and use

MiCollab for Mobile, users must have a mobile device that meets the documented requirements.

See “MiCollab for Mobile for requirements” on page 76

for device requirements. You must be licensed to use MiCollab for Mobile.

See

“MiCollab for Mobile features” on page 42 for a list of MiCollab for Mobile features.

Supported Communication Platforms (PBXs)

The following Mitel communication platforms provide call control for MiCollab Client desk phones and softphones:

• MiVoice Business Release 7.2 SP1: Formerly known as Mitel 3300 IP Communications Platform (ICP), the MiVoice Business call processing software is configured through the MiVoice

Business Administration Tool. MiVoice Business v5.0 SP2 is required for MiCollab Client

SIP softphone functionality.

• MiVoice Office 250 Release 6.1: The MiVoice Office 250 call processing software is configured through the MiVoice Office 250 Database Programming interface. MiVoice Office 250 v5.0 or

later is required for MiCollab Client SIP softphone functionality.

When deployed in a MiCollab environment, MiCollab Client can also be integrated with:

• MiVoice 5000 Release 6.2: The MiVoice 5000 call processing software is configured through the MiVoice 5000 administrator interface.

• MiVoice MX-One Release 6.0 SP2: The MiVoice MX-One call processing software is configured through the MiVoice MX-One administrator interface.

Overview

Users can access and use the communication system features provided by the communications platform from the MiCollab Client interfaces. Note that some features may not be supported on the user’s desk phone or softphone.

Mitel integrated applications

The following Mitel application components and versions are integrated with MiCollab Client:

• MiCollab Audio, Web and Video Conferencing - formerly known as Mitel Collaboration Advanced (MCA): Access to MiCollab Audio, Web and Video Conferencing is integrated within

MiCollab Client. If users are licensed for MiCollab Audio, Web and Video Conferencing, they

can use collaboration features (see “About Collaboration” on page 57 ) such as video calls, audio

conferencing, web conferencing, annotation, chat, file transfer, and desktop sharing.

• MiCollab Unified Messaging (UM): Provides access to Visual Voice Mail (MiCollab UM voice mail and FAX messages) from the MiCollab Client interfaces.

• MiVoice Border Gateway: MiVoice Border Gateway provides a secure communications path for remote MiCollab Client users to the MiCollab Client Service. This product is supported for

MiVoice Business communication systems only. MiVoice Border Gateway v7.1 and later is

required.

• Mitel Remote Proxy Services: Remote Proxy Services provide a secure communications path for remote MiCollab Web Client users. This product is supported for MiVoice Business communication systems only.

Optional third-party integrated applications

MiCollab Client includes support for the following third-party integrated applications:

• Personal Information Manager (PIM)s: PIMs allow users to easily import personal contacts into MiCollab Client. Supported PIMs include:

• Microsoft Outlook 2007, 2010 (32-bit and 64-bit), 2013 (32-bit and 64-bit)

• IBM Lotus Notes Server and Client 8.0, 8.5, 8.5.2, and 9.0

• Sage

Software Act!

2007, 2008, and 2011

• Google Calendar and contact integration

• Instant Messaging Clients: MiCollab Client includes its own integrated chat component. It also supports launching the following Instant Messaging clients when they are installed and running on the user's computer:

• Skype for Business, Lync 2010 and 2013

• Federation Servers: Federation provides a communication path between a single MMiCollab

Client Service and one or more external IM servers to provide MiCollab Client users with pres-

ence and chat features for external IM contacts (see page 26 ). MiCollab Client supports IM and

presence federation with the following servers:

• Skype for Business 2015, Lync 2010 and 2013 Server

• IBM Lotus Sametime

Server 8.5 and 9.0

MiCollab Client Administrator Guide

• Exchange Server: Exchange server integration enables users to integrate their dynamic status with their calendars whether or not they are logged into their PIM. This feature can be used with

Microsoft Exchange 2007, Exchange 2007 SP1, Exchange 2010, Exchange 2010 SP1, Exchange 2010 SP3, and Exchange 2013 SP1.

•

Office 365 Server: Office 365 server integration enables users to integrate their dynamic status with their Office 365 calendars.

• Google Server: Google server integration enables users to integrate their dynamic status with their Google calendars.

Overview

Documentation

Documentation for MiCollab Client includes the following:

• Administrator documentation includes:

• MiCollab Client Engineering Guidelines: The MiCollab Client Engineering Guidelines, part number 835.3288, provides system requirements, configuration information, network diagrams, virtualization information, performance recommendations, system capacities, etc. for sites installing the MiCollab Client product.

• MiCollab Client Administrator Guide: This MiCollab Client Administrator Guide, part number 835.3246, includes PBX configuration information, MiCollab Client specifications and hardware configuration information, and configuration information for integrated applications.

• MiCollab Client Administrator Online Help: Embedded in the MiCollab Client Service

Administrator Interface, this help system provides a high-level overview of the provisioning process with links to task-related instructions. The task-related instructions provide detailed descriptions for fields and options. To open the help, access the Mitel MiCollab Client Service

Configuration Web pages and click the help icon.

• MiCollab Vidyo Quick Reference Guide for Administrators: Provides configuration steps for MiCollab Vidyo integration.

• End-user documentation includes:

• MiCollab Client Quick Reference Guide: Provides installation, basic feature and usage information for the MiCollab Desktop Client, Web Portal and Mobile for BlackBerry, Android, iPhone, and Windows 8 devices. A link to the MiCollab Client Quick Reference Guide on the Mitel eDocs Web site is included in the Welcome e-mail message generated from the

MiCollab Client Service.

• MiCollab Client and BluStar Features Quick Reference Guide: Provides a feature comparison for MiCollab Client and BluStar.

• MiCollab Client Features Quick Reference Guide: Provides a feature comparison for

MiCollab Desktop, Web and Mobile clients.

• MiCollab Vidyo Quick Reference Guide for Users: Provides MiCollab VidyoDesktop users with quick installation and usage information.

• Online Help: Embedded in the user interface, the following help systems focus on interface elements, supported features, and task-related instructions:

MiCollab Desktop Client Help: To open the online help, select Help from the main menu or press the F1 function key on your keyboard.

MiCollab Web Portal Help: To open the Help, click the Help link at the top of the page.

MiVoice for Skype for Business Help: To open the Help, click the menu icon and select

Help.

User documentation for MiCollab Client is available in the following languages:

Dutch

English (US)

French (Canadian)

MiCollab Client Administrator Guide

French (European)

German

Italian

Portuguese (Brazilian)

Spanish (European)

Spanish (Latin America)

Swedish

Norwegian

Finnish

Note:

The user interface supports the following languages:

Chinese (Simplified), Chinese (Traditional), Dutch, English (US), English (UK), French

(Canadian), French (European), German, Italian, Portuguese (Brazilian), Spanish (European),

Spanish (Latin American), Swedish, Norwegian, and Finnish.

• MiCollab Client SDK Programmers Guide: The MiCollab Client Software Developers Kit and

SDK Programmers Guide, part number 835.3246, are optional components for software developers designing third-party applications that integrate with MiCollab Client. See the Mitel

Solutions Alliance (MSA) Web page for more information

(http://www.mitel.com/DocController?documentId=9971).

Documentation for the following Mitel integrated applications is available on the Mitel eDocs Web site (http://edocs.mitel.com):

• Mitel Standard Linux

(MSL)

• MiCollab

• MiCollab Audio, Web and Video Conferencing

• MiVoice Border Gateway and Remote Proxy Services

• Virtual Appliance Deployment

• VMware Horizon View Support

Chapter 2 Features

MiCollab Client Administrator Guide

Introduction

This chapter provides information about MiCollab Client features.

There are a total of 29 licensed features for MiCollab Client. Two of the features are server-level licensed features (

“Federation” on page 26 , and

“Peering” on page 28

), and are considered to be

“in use” at all times.

The remaining 27 licensed features are user-level licensed features (see “Client interface features” on page 31 ), and are allocated to a specified user. These types of features are considered to be “in

use” when you assign them to the user, regardless of whether or not the user is actually using the feature.

“MiCollab Client licensed features” on page 22 describes the MiCollab Client licensed features.

Feature Name

Auto Answer

Call Forwarding

Chat

Collaboration Integration

Compact Mode

Console Option

Desk Phone

Desktop client SDK

Table 2: MiCollab Client licensed features

Description

Incoming calls are answered at the first ring by the selected device. Users enable and disable this feature from the Dynamic Status dialog box on the MiCollab

Desktop Client.

The Call Forwarding feature allows users to:

• forward to any non-Personal Ring Group (PRG) destinations.

• add preferential contacts.

• send calls to dynamic extensions.

When users are not licensed for Call Forwarding, they can still send calls to their desk phones, softphones, and voice mail. In addition, users can set

Do-Not-Disturb and Auto Answer options.

Users can participate in online chat sessions with other users also licensed for chat. Users access the Chat submenu option when they right-click a contact from the Contacts view.

Users can access Collaboration features including the Collaboration submenu

(available from the main menu) and the Start Collaboration option when the user right-clicks one or more contacts.

See

“Server-Level features” on page 26 for more information about collaboration.

Users can switch between the full mode and Compact mode MiCollab Desktop

Client interfaces.

Users have access to the Console view from the main menu. The Console view provides access to attendant functions such as answer, transfer, hold, and the ability to view and change another user's status.

Users' desk phone extensions, as programmed on the PBX, are integrated with

MiCollab Client.

This license is required for MiVoice for Skype for Business feature.

Note:

MiVoice for Skype for Business Deskphone only users: those users only require the Desktop client and Desk phone SDK feature.

MiVoice for Skype for Business Softphone only users OR those users with a

Softphone and an associated Deskphone will require the Softphone feature in addition to the Desktop client SDK feature.

Page 1 of 4

Features

Feature Name

Do-Not-Disturb (DND)

Table 2: MiCollab Client licensed features (continued)

Description

Dynamic Status

External Dial

Users can enable and disable DND to override current Dynamic Status settings.

When DND is enabled, callers receive a busy tone and a Do-Not-Disturb message and incoming calls are not logged in the call log.

Users can manually change their Dynamic Status at any time using the

MiCollab

Client

interface, which is then communicated to other MiCollab Client users. In addition, Dynamic Status can also be configured to be automatically updated in response to many events, such as a user's Calendar availability. Users can also add statuses and configure the following Dynamic Status elements:

• Status Message (for example, In the office or Gone for the day)

• Optional custom text (for example, Reviewing reports or Back on Thursday)

• Instant Message and Video Call availability

• Preferential Contacts

• Phone Settings (Busy/no answer routing, DND, Auto Answer). Call routing options are not supported on MiVoice MX-One and MiVoice 5000 platforms.

When users are not licensed for Dynamic Status, they have only one status. This status provides call forwarding capabilities as long as the user is licensed and configured to use the Call Forwarding feature.

Users can dial an external number from an integrated application such as

Microsoft Word, Outlook, Internet Explorer

, and IBM Lotus Notes. The user may need to complete some configuration in the application to enable external dialing.

Federation

Knowledge Management

Launchpad

Mobile Handoff

Mobile SIP Softphone

The Federation feature provides MiCollab Client users with expanded IM capabilities. When the MiCollab Client Service is licensed for this feature, you can configure federation from the Federation Tab, and users can view IM presence and chat with federated IM contacts using the MiCollab Desktop Client's Chat window.

See

“Server-Level features” on page 26

for more information about federation.

Users can index computer files and documents associated with a contact. When the user receives an incoming call, the Knowledge Management popup window appears presenting the user with a list of files associated with the caller including e-mail messages, contact entries, and documents (Microsoft Word, Excel

Power

Point

, Outlook and Adobe

Portable Document Format).

Users can access the Launchpad view, which provides quick access to frequently completed actions, from their MiCollab Desktop Client. Actions include dialing a number, browsing to a URL, running a program, and exploring a folder.

Users on Mobile device can use the Call Handoff feature (ability to push a call to other devices within the Personal Ring Group).

NOTE: Handoff Feature Code: As a prerequisite, the MiVoice Business Feature

Code for Handoff must be programmed. If this feature is added to an existing server, the PBX need to be synchronized with MiCollab Client before the feature can be used.

Allows users to have SIP-Based Softphone on Desktop, Android and iOS clients.

(You must have the

MiCollab Client

Mobile for Smart Devices license enabled before you can enable the Mobile SIP Softphone license).

This feature is supported on MiVoice Office 250 and MiVoice Business systems only (MiVoice Business 5.0 SP2 and later release is required or MiVoice Office 250 running 5.1 or later release is recommended).

Page 2 of 4

MiCollab Client Administrator Guide

Feature Name

Table 2: MiCollab Client licensed features (continued)

Description

Peering

Phone Button Programming Users can configure the buttons on their 5312, 5320, 5324, 5330, 5340, or 5360

IP phone from the MiCollab Desktop Client.

This feature is limited to users on MiVoice Business communication platforms only.

Presence The Presence Server provides the following types of presence for

MiCollab

Client

users:

• Dynamic Status

•

• Telephony presence

MiCollab Client

chat presence

• IM presence

• Video presence

See

“About Presence” on page 54 for more information about presence.

Presence on Mitel Sets

The Peering licensed feature allows you to configure communication paths with other

MiCollab Client

Services for the purposes of sharing presence information and providing communication features between multiple MiCollab Client Services.

See

“Peering” on page 28 for more information about peering.

RSS Window

Softphone

Stand-alone MiCollab Web

Client

Users can configure presence information for speed call keys on their 5320, 5330,

5340, or 5360 IP phone from the MiCollab Desktop Client.

This feature is limited to users on MiVoice Business communication platforms only.

Users have access to the RSS window (Rich Site Summary), located at the bottom of the MiCollab Desktop Client UI. Typically, RSS feeds provide syndicated content such as events listings, news stories, headlines, excerpts from discussion forums, or corporate information to the user.

Users' softphone extensions, as programmed on the PBX, is integrated with

MiCollab Client.

The MiCollab Web Client provides users with remote access to a subset of

MiCollab Client features. This interface allows users to configure and change their

Dynamic Status, access call history data, view corporate contacts, access voice mail messages, and configure account options.

MiCollab for Mobile Users can install and use the MiCollab for Mobile client application on their

Android, BlackBerry, iPhone, Windows 8, or Windows 10 mobile device. MiCollab for Mobile application provides an integrated environment in which users can manage Dynamic Status, communicate with corporate contacts, and access visual voice mail and call history. Depending on the device, shortcuts and widgets provide customization options for users. When using the MiCollab Client Service

Configuration interface to assign licenses, this feature will appear as “

MiCollab

Client

Mobile for Smart Devices” and will represent a consolidated license count for the Android, BlackBerry, and iPhone licenses.

The

MiCollab Client

Mobile for Smart Devices was previously known as the

Locator.

Video Calls Users have access to video presence for Corporate Contacts and can participate in point-to-point and multi-party video sessions. Video services for the MiCollab

Desktop Client are provided by MiCollab Audio, Web and Video Conferencing and

MiCollab Vidyo. See MiCollab Audio, Web and Video Conferencing and MiCollab

Vidyo documentation, available on Mitel eDocs Web site, for additional licensing information.

Page 3 of 4

Features

Feature Name

Visual Voice Mail

Table 2: MiCollab Client licensed features (continued)

Description

Users have access to the following MiCollab Unified Messaging (UM) voice mail features from the Visual Voice Mail view:

• Receive message waiting indications

• Play, forward, and delete voice mail messages

• View, forward, and delete fax messages

• Change the voice mail PIN

Supported on systems with MiCollab UM voice mail only.

Page 4 of 4

1. The Auto Answer feature conflicts with the MiVoice Office 250 Dynamic Extension Express feature.

2. SIP softphone should not be used with MiCollab Client console. MiCollab Client console is not supported on Citrix, VMWare or Windows Terminal Server.

MiCollab Client Administrator Guide

Server-Level features

Server-level licensed features include:

•

Federation , below

•

“Peering” on page 28

Federation

Federation provides a communication path between a single MiCollab Client Service and one or more external IM servers to provide MiCollab Client users with presence and chat features for external IM contacts. The communication path between the MiCollab Client Service and the external

IM server uses the Extensible Messaging and Presence Protocol (XMPP).

Figure 2

provides a basic federation configuration diagram.

Figure 0-1

Figure 2: Federated servers

Note:

For v6.0, external IM server support is limited to Microsoft Lync 2010, Google and IBM Lotus®

Sametime® Server 8.5, 8.5.1, and 8.5.2.

MiCollab Client Service federation capabilities are provided by the following services:

• Subscription Federation service: Creates subscriptions for local MiCollab Client users to external presence servers.

• Presence Gateway service: Sends presence information to/from the MiCollab Client Presence

Server (see

“Presence server” on page 54 ) and the external IM presence server. This service

translates information from SIP to XMPP, and vice versa. The Presence Gateway service allows

MiCollab Desktop Client users to view and refresh IM presence information for external IM

Features

contacts. MiCollab Client account presence (Dynamic Status) and telephony presence is not available through this service.

• Instant Messaging (IM) service: Allows MiCollab Desktop Client users to chat (point-to-point) with external IM contacts using the MiCollab Desktop Client Chat window. Federated chat sessions are page-mode conversations, similar to a two-way pager device or Short Message Service

(SMS), where a small number of independent messages are exchanged between two participants and are perceived as part of the same conversation. Page mode does not support multi-party chat or file transfer.

There are two options you can use to configure Federation using the MiCollab Client Service

Administrator interface:

• Configure an external IM server and perform an AD/LDAP synchronization with the server from the Peer Server Details page. After synchronization, the IM server contacts are imported to the

MiCollab Client Service database (visible from the Corporate Directory Tab, see Figure 4 on page 29 ) and federation is automatically enabled. When you configure federation this way, fed-

erated contacts are displayed in a separate list in the user's corporate directory from the MiCollab

Desktop Client's Contacts View, similar to peered contacts (see

Figure 4 on page 29 ).

• Enable Federation and configure the federated server domain from the Federation Tab. When you configure federation this way, instruct users to manually add the federated contacts. Users should create a new personal contact, and then add the IM login information for the contact using the MiCollab ClientLogin option.

See the MiCollab Client Service Administrator interface online help for information and instructions about configuring federation for MiCollab Client Service.

Note the following guidelines for Federation:

• The site must purchase the Federation license for MiCollab Client Service (see

Table 2 on page 22 ).

• The external IM server must be installed and the IM server’s XMPP gateway must be deployed before you can configure federation for MiCollab Client Service. See the IM server’s documentation for information about configuring federation for the IM server.

Note:

Google Federation specific: Google Apps server hostname domain must be different from the

MiCollab Client Service hostname domain for the federation to work. In addition, the MiCollab

Client Service hostname domain should not have the same root parent domain as the Google

Apps server.

For example, Google Federation will not work if MiCollab Client Service hostname is usmas12.company.com and Google Apps server hostname is google.company.com.

See MiCollab Client Engineering Guidelines for further details.

• Presence for federated contacts is limited to IM presence only. MiCollab Client account and telephony status is not provided.

MiCollab Client Administrator Guide

• Chat for federated contacts is limited to point-to-point only. Multi-party chat and file transfer is not available.

Note:

Federation with Border Gateway in the network path between MiCollab Client Service and the federated server (Skype for Business, IBM Sametime or Google server) is supported as of

MiCollab Client 6.0. This is accomplished by adding Border Gateway connector for TCP port

5269 in Border Gateway v8.0.

Peering

MiCollab Client Service Peering configures a communication path between a local MiCollab Client

Service and one or more peered MiCollab Client Services within the same company or between different companies on the same server. Peering MiCollab Client Services provides greater scalability for the MiCollab Client product. MiCollab Client Service peering supports a combined maximum of 40,000 clients in the configuration.

It is possible to peer a MiCollab Client Service connected to multi-node MiVoice Business system with a MiCollab Client Service connected to a multi-node MiVoice Office 250 system (see

Figure 3 ).

Figure 0-2

Figure 3: Peered MiCollab Client Services

To configure MiCollab Client Service peering, add one or more MiCollab Client Services from the

Peering Tab – Peer Server Details page in the MiCollab Client Service Administrator interface.

Note:

The enterprise domain should be unique for each MiCollab Client Service peer. See the MiCollab

Client Service Administrator interface online help for details.

In addition to peering with MiCollab Client Services, you can configure Federation with an external

IM server from the Peer Server Details page by adding the external server and performing an

Features

AD/LDAP synchronization with the server. See

“Federation” on page 26

for details about Federation configuration.

See the MiCollab Client Service Administrator interface online help for information and instructions about configuring peering for MiCollab Client Service.

After peering has been established and a synchronization performed, peered contacts are displayed on the Corporate Directory tab in the MiCollab Client Service Administrator interface. Peered corporate directories appear as sub-folders to the top-level local Corporate Directory (see

Figure 4 on page 29 ). For each peered server, the directory tree structure displayed under the local Corporate

Directory folder mirrors the corporate directory structure on the peer server itself.

Figure 0-3

Figure 4: Peered Corporate Directories-MiCollab Client Service Administrator Interface

Peered contacts are located in the MiCollab Desktop Client Contacts view, and are organized within

the expanding peered server corporate directory (see Figure 5 ). MiCollab Desktop Client users can

view presence information for peered contacts and can use MiCollab Client communication features such as chat, video, and collaboration with peered contacts.

Users can expand each peered server corporate directory to access peered contacts. Local corporate contacts appear below the peered corporate directories.

Figure 0-4

Figure 5: Peered Corporate Contacts-MiCollab Desktop Client

Note the following guidelines for peered MiCollab Client Services:

• All peered MiCollab Client Services must be running identical versions of MiCollab Client software.

MiCollab Client Administrator Guide

• To peer with another MiCollab Client Service, a site must purchase the Peering license (see

Table 2 on page 22 ). The Peering license controls the connection initiated by the local MiCollab

Client Service and not the connection established from the peer MiCollab Client Service.

• Each MiCollab Client Service in a peered configuration operates independently and is maintained and managed by the administrator assigned to that server. If a MiCollab Client Service in a peered configuration is unavailable, the other servers in the configuration are not affected.

• If contacts are hidden from the corporate directory on the local MiCollab Client Service, they will also be hidden on a peered MiCollab Client Service.

• Call routing rules must be configured properly in the PBX to route calls properly to the peered server. The Peer Server Details page includes a field called Peer Dialing Prefix. The value you enter for the Peer Dialing Prefix corresponds with the dialing prefix (not including the outgoing call digit) that PBX users must dial to call an extension on the networked PBX.The Peer Dialing

Prefix is only required for PBX-to-PBX calls where the networked PBXs are not configured for transparent extension dialing.

• When MiCollab Client Services are peered, the voice mail systems between the servers must be networked and configured properly so that users are able to forward voice mail messages to users on other servers.

Features

Client interface features

MiCollab Client includes the following interfaces, which provide access to user-level features:

•

MiCollab Desktop Client (see Table 3 MiCollab Desktop Client UI features )

•

MiCollab MAC Desktop Client (see Table 4 MiCollab MAC Desktop Client UI features )

• MiVoice for Skype for Business Client (see

Table 5 MiVoice for Skype for Business UI features )

• Web Portal (see

Table 6 MiCollab Web Client UI features

)

• MiCollab for Mobile (see

Table 7 MiCollab for Mobile features )

This section describes the main features provided by the end-user interfaces.

MiCollab Desktop Client features

Table 3 provides descriptions for the main features accessed from the MiCollab Desktop Client UI.

Feature Name

Table 3: MiCollab Desktop Client UI features

Description Notes

Account Options

ACD

The My Account dialog box provides configuration options that the user can set for his or her account. Options include uploading a photo, changing password and log in options, and adding phone, e-mail, and IM contact information for publication and routing purposes.

The MiCollab Desktop Client provides the ACD view for

ACD hunt group agents using the communication system

ACD features.

MiCollab Client

supports the following types of ACD:

• ACD traditional agents (MiVoice Business communication system)

• ACD Hunt Groups (MiVoice Office 250 and communication system)

The ACD view is an optional component for

MiCollab

Client

Auto Answer

Calendar Integration Calendar integration provides Dynamic Status updates based on the user's Busy and Out of Office settings in their

Google Calendar, Outlook, Lotus Notes, Office 365, or

Exchange calendar.

Call Annotation

When the Auto Answer feature is enabled, incoming calls are answered at the first ring by the selected device (Desk

Phone or Softphone). Users enable and disable this feature from the Dynamic Status dialog box on the MiCollab

Desktop Client.

Call Annotation features are displayed in the Call Window when you are on an active call and include:

• Notes: Provides an text box to add notes about the call.

• Recorder

: Records the current call.

The recorder function is provided by the

MiCollab

Client

embedded softphone, which is a licensed feature (see

Table 2 on page 22 ).

Page 1 of 5

MiCollab Client Administrator Guide

Feature Name

Call Control

Call Forwarding

Call Handoff

Call History

Chat

Collaboration

Compact Mode

Table 3: MiCollab Desktop Client UI features (continued)

Description Notes

Call Control features are displayed in the Call Window and provide one-click access to the following call control features:

• Call Me Back (MiVoice Business systems): Provides call me back notifications for internal calls only.

• Leave Station Message (MiVoice Office 250

systems): Delivers a station message (flashing LED indicator) on the internal destination device.

• Hold/Retrieve Held: Places/retrieves a call on hold.

• End Call: Ends the call.

Call Me Back and Split are supported on MiVoice

Business systems only.

Leave Station Message is supported on MiVoice

Office 250 systems only.

• Transfer, Conference: Allows the user to complete a transfer or conference. Includes the complete, cancel, or consult associated actions.

• Split: Places the party that joined the call last on hold.

This feature is not supported by the MiVoice Office 250 communication system.

• Trade: During a consult call or a split call, this control places the active party on hold, and makes the other party active.

The Call Forwarding feature allows users to forward calls to non-Personal Ring Group (PRG) destinations and dynamic extensions. In addition, users can configure forwarding for preferential contacts.

The Call Handoff feature allows users to either push an active call to another device or pull in a call to a selected device within their Personal Ring Group.

Requires a 3300 system running 10.3 and higher as well as MiVoice

Business 4.2.

Provides a list of missed, received, and dialed calls that includes caller ID and presence information for known contacts.

Provides multi-party chat functionality for corporate contacts. Chat features include emoticons, timestamp, file transfer, chat history, and user configurable chat alert sounds.

Collaboration is an optional component that provides extended conferencing functions as well as provide annotation, file transfer, application sharing, desktop sharing, and video capabilities from a Mitel integrated conferencing product.

Compact Mode provides access to frequently-used

MiCollab Client

features from a minimized interface that can be moved to any area of your desktop.

Page 2 of 5

Features

Feature Name

Table 3: MiCollab Desktop Client UI features (continued)

Description

Configuration Options Configuration options allow the user to customize the following features for the MiCollab Desktop Client:

• Appearance

• Calendar Integration

• Call Notification

• Chat Settings

• Knowledge Management

• Login Notification

• PIM Integration

• RSS Window

• Teleworker

• Softphone Settings

• Contacts View

Console

The

MiCollab Client

Console is an optional component that provides attendant call handling functions such as answer, transfer, hold, and conference. When a user is licensed for the console, it is available from the MiCollab

Desktop Client main menu and Dynamic Status view.

Notes

Split Conference is supported on MiVoice

Business systems only.

Transfer to Hold is supported on MiVoice

Office 250 systems only.

Console is not supported on MiVoice MX-One and

MiVoice 5000 systems.

Contact Management Corporate contacts are provided by the

MiCollab Client corporate directory. Users can view detailed information

(including uploaded photos) for each corporate contact, as well as presence information. Users can import personal contacts from their PIMs, or create them manually, and then organize them into groups.

Dynamic Status

External Dialing

Dynamic Status provides customized call routing, IM and video presence, and calendar integration for

MiCollab

Client

users. In addition to displaying the user’s current

Dynamic Status, the Dynamic Status view includes communication notification icons, which indicate new messages and missed calls.

MiCollab Client

provides external dialing functionality for the following applications:

• Microsoft Word and Excel: Users must configure Smart

Tags/Actions for external dialing from Word and Excel.

• Microsoft Outlook: Users must configure Smart

Tags/Actions for external dialing from Outlook.

• IBM Lotus Notes: The Lotus Notes Toolbar provides external dialing from Lotus Notes.

• Microsoft Internet Explorer: The

MiCollab Client

Dialing Helper Add-On provides external dialing in IE.

Favorites Favorites include the list of corporate and personal contacts that the user has assigned as a Favorite.

Page 3 of 5

MiCollab Client Administrator Guide

Feature Name

Hot Desking

Table 3: MiCollab Desktop Client UI features (continued)

Description

Provides the ability to Hot Desk in and Hot Desk out of supported systems by a simple right-click operation.

Notes

This feature is limited to users on MiVoice

Business communications platform only.

IM Client Integration Users licensed for Office Communicator Integration can launch an IM session from the MiCollab Desktop Client with any contact who has a corresponding login for the application and is currently logged in to the application.

Knowledge

Management

Launchpad

Provides indexing and search functions to correlate files and e-mail messages with users’ contacts.

Provides easy access to frequently-performed tasks.

Launchpad items are associated with actions (Dial a number, Browse to a URL, Run a program, and Explore a folder) and appear on the Launchpad as buttons.

Notifications

Phone Button

Programming

PIM Integration

Presence

Popup windows (incoming call, call me back, chat invitation, collaboration invitation, and login notification) and auditory alerts (new chat, chat received, knowledge management window, and login notification) provide users with notification when events occur.

Buttons can be configured by users on their 5312, 5320,

5324, 5330, 5340, or 5360 IP phone from the MiCollab

Desktop Client.

This feature is limited to users on MiVoice

Business communication platforms only.

Creates a connection between

MiCollab Client

and the contacts in the user’s PIM. Supported PIMs include

Microsoft Outlook, IBM Lotus Notes, and Sage Software

ACT!

Presence information (telephony, video,

MiCollab Client chat, integrated IM) for corporate contacts uses Dynamic

Presence (replacement for Universal Presence and

On-Demand Presence).

Presence on Mitel

Sets

Users can configure presence information for multiple contacts on their 5320, 5330, 5340, or 5360 IP phone from the MiCollab Desktop Client.

This feature is limited to users on MiVoice

Business communication platforms only.

RSS Content The RSS window provides access to scrolling Rich Site

Summary (RSS) content such as news headlines, excerpts from discussion forums, or corporate information displayed in the RSS Window. The RSS window provides links to Web content and additional RSS feeds, as well as navigation capabilities.

SIP-Based Softphone Provides a SIP-Based Softphone to the MiCollab Desktop

Client

This feature is supported on MiVoice Business systems running 5.0 SP2 or MiVoice Office 250 running 5.1 or later release.

Page 4 of 5

Features

Feature Name

Softphone

Table 3: MiCollab Desktop Client UI features (continued)

Description

The MiCollab Desktop Client provides an embedded softphone that users can use with a USB headset or handset to place and receive calls. The softphone extension must be configured on the PBX.

Notes

Teamwork Mode

Teleworker

Teamwork Mode provides the ability for a desktop user to have certain

MiCollab Client

functions without having a

Mitel phone (without being tied to a PBX). Non-telephony based features such as contact grouping, presence, dynamic status and chat are supported.

Teleworker mode allows MiVoice Business users to connect to and access their MiVoice Business voice network through the

MiCollab Client

softphone or IP desk phone from a remote location. In Teleworker mode, the remote

MiCollab Client

uses a secure SSL connection with the MiVoice Border Gateway for all communication between the client and the

MiCollab Client

Service.

Supported on MiVoice

Business systems with an

Border Gateway installed on site.

Tray Icon and Menu Provides a visual indication of the user's telephony presence, message waiting indication, and menus for frequently-used features such as Set Status, Voice Mail,

Missed Calls, and Do-Not-Disturb.

Video Call/Presence A video call includes an audio call established by the PBX and a video broadcast established by MiCollab Audio, Web and Video Conferencing. The user can configure video presence for each Dynamic Status to indicate if he or she is available for video calls. The Video Contacts view provides a list of contacts available for video calls.

Requires MiCollab Audio,

Web and Video

Conferencing 4.0 or later.

Visual Voice Mail Provides access to the following voice mail features:

• Receive message waiting indications

• Play, forward, and delete voice mail messages

• View, forward, and delete fax messages

• Change the voice mail PIN

Visual Voice Mail is only available on systems with

MiCollab UM voice mail.

Page 5 of 5

1. The embedded softphone records and saves call recordings to the user’s computer. It does not save the recordings in the user’s voice mailbox like the PBX Record-A-Call (RAC) feature. Note that users cannot use the Recorder option in the MiCollab Desktop Client and PBX RAC feature simultaneously. To use the MiCollab Client record feature, the user must be provisioned with the Softphone licensed feature (see

Table 2 on page 22 ).

2. SIP softphone should not be used with MiCollab Client console.

MiCollab Client Administrator Guide

MiCollab MAC Desktop Client features

Table 4

provides descriptions for the main features accessed from the MiCollab MAC Desktop Client

UI.

Table 4: MiCollab MAC Desktop Client UI features

Feature Name

Account Options

Description

Notes

Auto Answer

Calendar Integration Calendar integration provides Dynamic Status updates based on the user's Busy and Out of Office settings in their

Google Calendar, Outlook, Lotus Notes, Office 365, or

Exchange calendar.

Call Control

When the Auto Answer feature is enabled, incoming calls are answered at the first ring by the selected device (Desk

Phone or Softphone). Users enable and disable this feature from the Dynamic Status dialog box on the MiCollab MAC

Desktop Client.

Call Control features are displayed in the Call Window and provide one-click access to the following call control features:

• Call Me Back (MiVoice Business systems): Provides call me back notifications for internal calls only.

• Leave Station Message (MiVoice Office 250

systems): Delivers a station message (flashing LED indicator) on the internal destination device.

• Hold/Retrieve Held: Places/retrieves a call on hold.

• End Call: Ends the call.

Call Me Back and Split are supported on MiVoice

Business systems only.

Leave Station Message is supported on MiVoice

Office 250 systems only.

• Transfer, Conference: Allows the user to complete a transfer or conference. Includes the complete, cancel, or consult associated actions.

• Split: Places the party that joined the call last on hold.

This feature is not supported by the MiVoice Office 250 communication system.

• Trade/Toggle: During a consult call or a split call, this control places the active party on hold, and makes the other party active.

• In/Out group (MiVoice Business Call manager integration)

Call Forwarding The Call Forwarding feature allows users to forward calls to non-Personal Ring Group (PRG) destinations and dynamic extensions. In addition, users can configure forwarding for preferential contacts.

Page 1 of 4

Features

Table 4: MiCollab MAC Desktop Client UI features (continued)

Feature Name

Call Handoff

Description

The Call Handoff feature allows users to either push an active call to another device or pull in a call to a selected device within their Personal Ring Group.

Notes

Requires a 3300 system running 10.3 and higher as well as MiVoice

Business 5.0 SP2 or higher

Call History

Chat

Collaboration

Provides a list of missed, received, and dialed calls that includes caller ID and presence information for known contacts.

Missed calls trigger notifications visible in the notification center.

Provides multi-party chat functionality for corporate contacts. Chat features include emoticons, timestamps, file transfer, chat history, and user configurable chat alert sounds.

New chat requests trigger notifications visible in the notification center.

Collaboration is an optional component that provides extended conferencing functions.

MiCollab MAC Desktop Client can receive requests to join adhoc sessions from a user on the MiCollab Desktop Client.

When accepted, the configured default device rings and the

MiCollab Audio, Web and Video Conferencing viewer is launched.

Compact Mode Compact Mode provides access to frequently-used

MiCollab Client

features from a minimized interface that can be moved to any area of your desktop.

Configuration Options Configuration options allow the user to customize the following features for the MiCollab Desktop Client:

• Appearance

• Calendar Integration

• Call Notification

• Chat Settings

• Login Notification

• PIM Integration

• Softphone Settings

• Contacts View

Contact Management Corporate contacts are provided by the

MiCollab Client corporate directory. Users can view detailed information

Page 2 of 4

MiCollab Client Administrator Guide

Feature Name

Dynamic Status

Table 4: MiCollab MAC Desktop Client UI features (continued)

Description

Dynamic Status provides customized call routing, IM and video presence, and calendar integration for

MiCollab

Client

users. In addition to displaying the user’s current

Dynamic Status, the Dynamic Status view includes communication notification icons, which indicate new messages and missed calls.

Notes

Favorites

Hot Desking

Hotkey Dialing MiCollab Client provides external dialing by highlighting a phone number on the screen and clicking a predefined hot key or combination of keys to dial the highlighted number.

IM Client Integration Users licensed for federation integration with a supported third party IM server can launch an IM session from the

MiCollab MAC Desktop Client with any contact who has a corresponding login for the application and is currently logged in to the application.

Launchpad Provides easy access to frequently-performed tasks.

Launchpad items are associated with actions (Dial a number, Browse to a URL, Run a program, and Explore a folder) and appear on the Launchpad as buttons.

Message Wait

Indicator

Favorites include the list of corporate and personal contacts that the user has assigned as a Favorite.

Provides the ability to Hot Desk in and Hot Desk out of supported systems by a simple right-click operation.

This feature is limited to users on MiVoice

Business communications platform only.

Notifications

PIM Integration

Presence

Message Wait Indicator is supported for integrated voicemail when NuPoint is not in place (for example,

MiVoice MX-One).

Notification center within the notification center (incoming call, call me back, chat invitation, collaboration invitation, new NuPoint voicemail and login notification) and auditory alerts (new chat, chat received, and login notification) provide users with notification when events occur.

Creates a connection between

MiCollab MAC Desktop

Client

and the contacts in the user’s PIM. Supported PIMs include Microsoft Outlook, IBM Lotus Notes, and Sage

Software ACT!

Presence information (telephony, video,

MiCollab Client chat, integrated IM) for corporate contacts uses Dynamic

Presence (replacement for Universal Presence and

On-Demand Presence).

Shortcuts Provides easy access to frequently-performed tasks.

Launchpad items are associated with actions (Dial a number, Browse to a URL, Run a program, and Explore a folder) and appear on the Launchpad as buttons.

Administrators can provision a predefined list of shortcuts.

Page 3 of 4

Features

Table 4: MiCollab MAC Desktop Client UI features (continued)

Feature Name Description Notes

Teamwork Mode

Teleworker

Teamwork Mode provides the ability for a desktop user to have certain

MiCollab Client

functions without having a

Mitel phone (without being tied to a PBX). Non-telephony based features such as contact grouping, presence, dynamic status and chat are supported.

Teleworker mode allows MiVoice Business users to connect to and access their MiVoice Business voice network through the

MiCollab Client

softphone or IP desk phone from a remote location. In Teleworker mode, the remote

MiCollab Client

uses a secure SSL connection with the MiVoice Border Gateway for all communication between the client and the

MiCollab Client

Service.

Supported on MiVoice

Business, MiVoice

MX-One and MiVoice

5000 systems with an

Border Gateway installed on site.

Tray Icon and Menu Provides a visual indication of the user's telephony presence, message waiting indication, and menus for frequently-used features such as Set Status, Voice Mail,

Missed Calls, and Do-Not-Disturb.

Requires MiCollab Audio,

Web and Video

Conferencing 4.0 or later.

Visual Voice Mail Provides access to the following voice mail features:

• Receive message waiting indications

• Play, forward, and delete voice mail messages

• View, forward, and delete fax messages

• Change the voice mail PIN

Visual Voice Mail is only available on systems with

MiCollab UM voice mail.

Page 4 of 4

MiVoice for Skype for Business features

Table 5 provides descriptions for the main features accessed from MiVoice for Skype for Business UI.

Table 5: MiVoice for Skype for Business UI features

Feature Name Description Notes

Auto Answer

Conference

Call Forwarding

Call History

Do Not Disturb

When the Auto Answer feature is enabled, incoming calls are answered at the first ring by the selected device

(Deskphone or Softphone).

Allows the user to add a third-party to the call.

The Call Forwarding feature allows users to forward calls using Call Forward Always, Call Forward No answer or

Call Forward Busy options.

Provides a list of missed, received, and dialed calls that includes caller ID (if available).

Users can enable and disable Do Not Disturb (DND).

When DND is enabled, callers receive a busy tone.or go to

Voicemail (if programmed).

MiCollab Client Administrator Guide

Feature Name

Edit Dial Strings

Smart Tags

Transfer

Table 5: MiVoice for Skype for Business UI features

Description

Users have the option to edit dial strings for outbound calls.

Users can use Smart Tags, known as Actions in Office

2010. When you enable Smart Tag/Actions in Microsoft

Word, Excel and Outlook, you can select proper names or numbers and then call the number using MiVoice for

Skype for Business.

Allows the user to transfer the call (supervised and unsupervised transfers are supported).

Notes

Note: MiNET softphone is not supported with current version of MiVoice for Skype for Business.

Note: MiVoice for Skype for Business does not support making calls from Outlook using TAPI.

MiCollab Web Client features

Table 6

provides descriptions for the main features accessed from the MiCollab Web Client.

Feature Name

Auto Answer

Table 6: MiCollab Web Client UI features

Description

Account Options Provides a way for users to edit their Dynamic Extensions, update their password, and change their time zone.

When the Auto Answer feature is enabled, incoming calls are answered at the first ring by the selected device (Desk Phone or

Softphone). Users enable and disable this feature from the Dynamic

Status dialog box on the MiCollab Desktop Client.

Call Forwarding

Call Handoff

Call History

Conference

Chat

Notes

The Call Forwarding feature allows users to forward calls to non-Personal Ring Group (PRG) destinations and dynamic extensions. In addition, users can configure forwarding for preferential contacts.

The Call Handoff feature allows users to either push an active call to another device or pull in a call to a selected device.within their

Personal Ring Group.

Provides call history information for missed, received, and placed calls.

MiVoice Business systems only.

• Conference: Allows a user to go from a point-to-point call to a multi-party call.

• Split: Once a three-party conference call is established, any participant can split the conference. One participant will go on hold and the other two will remain connected.

• Trade: During a consult call or a split call, this control places the active party on hold, and makes the other party active.

Maximum members in a conference is limited by the PBX.

Provides multi-party chat functionality for corporate contacts. Chat features include emoticons, timestamp, file, chat history, and user configurable chat alert sounds.

Feature Name

Contacts

Table 6: MiCollab Web Client UI features (continued)

Description

Provides a list of corporate contacts, a search function, and a way to view contact details. With

MiCollab Client

5.0 you can also group contacts.

Notes

Do Not Disturb

Dynamic Status

Messages

OfficeLink

Users can enable and disable DND to override current Dynamic

Status settings.

When DND is enabled, callers receive a busy tone and a

Do-Not-Disturb message and incoming calls are not logged in the call log.

Displays users’ current status and allows them to change, add, edit, and delete Dynamic Statuses.

Provides a list of users’ current voice mail and FAX messages, access to initialize and change the voice mail PIN, and a way to download them to the device.

Allows users to place calls from the Web Portal using one of the devices configured for their

MiCollab Client

account. You must have Personal Ring Groups (PRG) configured to use OfficeLink.

See

“OfficeLink functionality” on page 60 for

OfficeLink information.

Teamwork Mode Teamwork Mode provides the ability for a Web-based client to have certain

MiCollab Client

functions without having a Mitel phone

(without being tied to a PBX). Non-telephony based features such as contact grouping, presence, dynamic status and chat are supported.

Transfer / Consult Allows users to transfer an active call or consult a third-party. This action can also initiate a multi-party conference.

Note: MiVoice Office 250 does not support web portal mid-call features.

Features

MiCollab Client Administrator Guide

MiCollab for Mobile features

Table 7

provides descriptions for the main features accessed from the MiCollab for Mobile client.

Feature Name

Call History

Table 7: MiCollab for Mobile features

Description

The user can access call history for missed, received, and dialed calls.

Chat Provides multi-party chat functionality for corporate contacts.

Chat features include emoticons, timestamp, file transfer, chat history, and user configurable chat alert sounds.

Calendar Integration Integrates

MiCollab Client

with either your Google, Office 365, or Exchange Server. Regardless of whether or not you are logged into your Calendar or Microsoft Outlook, your

MiCollab

Client

Dynamic Status can access your calendar information directly from the server and update your Dynamic Status appropriately.

Configuration After the application is installed, the user must run the Setup

Wizard to configure basic

MiCollab Client

options. The user can access credentials and settings at any time from the Settings

– Options menu.

Corporate Contacts Allows the user to access all corporate contact information stored on the

MiCollab Client

Service.

Dynamic Status This screen allows users to view and change Dynamic Status and add custom text to their Dynamic Status. The Update Status option in the main menu allows users to update their status based on the current GPS or Bluetooth location.

Messages The user can call voice mail, view, and play received messages.

Presence

Scheduler

Teamwork Mode

Telephony, Instant Messaging and dynamic status presence.

Configures GPS and Bluetooth search intervals and time-out options to conserve battery power on your mobile device.

Teamwork Mode provides the ability for an Android user to have certain

MiCollab Client

functions without having a Mitel phone

(without being tied to a PBX). Non-telephony based features such as contact grouping, presence, dynamic status, and chat are supported.

Notes

Features

Communication platform features

In addition to the licensed features provided by MiCollab Client (see

Table 2 on page 22 ), users can

access and use the features provided by the following supported communication platforms:

•

MiVoice Business features , below

•

“1. ACD Silent Monitor is supported for ACD hot desk agents on MiNET softphones only.” on page 49

•

“About Account Synchronization” on page 53

Some PBX features may not be supported on the user’s desk phone or softphone. In the following tables, supported features are indicated by

and features not supported are indicated by



MiVoice Business features

Table 8 provides the MiVoice Business PBX feature matrix.

Features

Ability to work offline

Account Codes

– Default

Account Codes – System

Account Codes – Verified and Non-verified

ACD Support

Add Held

Advisory Message

Auditory Alerts (accessibility/disability)

Auto Answer

Auto-Answer

Auto-Hold

Broker’s Call

Calculator

Call Duration Display

Call Forward

Table 8: MiVoice Business PBX feature matrix

MiCollab Client

Call Forward – Cancel All

Call Forward – Delay

Call Forward – Follow Me – End Chaining

Call Forward – Follow Me – Reroute when Busy

Desk Phone



Non-verified







Softphone



Non-verified









Page 1 of 5

MiCollab Client Administrator Guide

Table 8: MiVoice Business PBX feature matrix (continued)

MiCollab Client

Features

Call Forward – Forced

Call Forward – Override

Call Forward profiles

Call Handoff

Call History

Call history / logs – local

Call history / logs – server-based

Call Me Back

Call Park

Call Park Retrieve

Call Pickup (Dialed, Directed, Clustered)

Call Privacy

Call timer and annotation tools

Call Waiting – Swap Automatic

Callback

Caller ID-based call routing

Camp-on

Clear All Features

Compression Support

Conference

Conference Application (controls Conference Unit)

Conference Split

Conference Unit Support (5305/5310)

Contact sync from Outlook to

MiCollab Client

Corporate Directory

Corporate Directory – LDAP sync (inc. Active

Directory)

Desk Phone



























Softphone



 2













 3













Corporate Directory – sync to MiVoice Business directory

 

Destination-based Call Display

Dial from PIM – Outlook 2003, 2007, 2010 (32 and 64 bit), Lotus Notes 8.0 and 8.5









Dial Tone – Outgoing Calls

 

Page 2 of 5

Features

Dialed Number Editing

Direct Outward Dialing (DOD)

Direct Page – Initiate

Direct Page – Receive

Do Not Disturb

Drag-and-drop conference calls

Favorites menu

Feature Keys

Flash – Calibrated

Flash – Switchhook

Flash – Trunk

Flexible Answer Point

Gigabit Ethernet Stand Support

Group Listen

Group Page – Initiate

Group Page – Receive

Handset Receiver Volume Control

Handsfree Answerback

Handsfree Operation

Headset Mute Switch

Headset Operation

Hold

Hold Key Retrieves Last Held Call

Hold on Hold

Hot Desking

Hot Line

Table 8: MiVoice Business PBX feature matrix (continued)

MiCollab Client

Features

In-call control window allowing transfer, conference, hold and hang up

Desk Phone



























Softphone























Knowledge Management

Language Change

Launch of

MiCollab Client

at computer start

LCS integration



Page 3 of 5

MiCollab Client Administrator Guide

Music

Mute Key

Override

Phonebook

PKM Support

Record a Call

Redial

Release

Reminder

Table 8: MiVoice Business PBX feature matrix (continued)

MiCollab Client

Features

Licensing through the Mitel AMC

Line Interface Module Support

Line Types and Appearances

Meet Me Answer

Messaging – Advisory

Messaging – Callback

Messaging – Dialed

Mobile Extension

Multiple Message Waiting Indicator

Off-Hook Voice Announce

Override Security

PC Programming Application Support (Desktop Tool)

Personal Directory

PIM Integration – ACT!

PIM Integration – Lotus Notes

PIM Integration – Outlook

Presence Indicator – Busy Lamp Field (BLF)

Presence Indicator – Computer

Privacy Release

Redial – Saved Number

Resiliency Support

Ringer Control (Pitch and Volume)

Ringing Line Select

Desk Phone







































Softphone





























 4











Page 4 of 5

Features

RSS Window

Table 8: MiVoice Business PBX feature matrix (continued)

MiCollab Client

Features

Screen-pops on calls with ability to forward, send to voice mail

Desk Phone



Softphone



Secure instant messaging (chat) with file transfer

Silent Monitor

Simplified Account Code Entry

SIP Support

Softkey Support

Speaker Volume Control

Speed Call – Pause

Speed Call – Personal

Speed Call – System

Speed Call Keys

Station-to-Station Dialing

SuperKey

Swap

System tray status icon

Tag Call (Malicious Call Trace)

Teleworker Support

Tone Demonstration

Transfer

Trunk Access

Trunk Answer From Any Station (TAFAS)

Visual Voice Mail

Voice Mail

Web browser

Wireless LAN Stand Support

WLM Integration































































Page 5 of 5

1. Account code dialing is not supported on SIP softphone.

2. Functionality is limited or provided in a way different from a non-MiCollab Client desk phone.

3. Conference feature is not supported on SIP-based softphone.

4. Resiliency is supported for MINET softphones using a 5020 IP set type. In MiCollab

Release 7.1 and later, MiCollab Client for Mobile softphones support Domain Name System (DNS)-based SIP resiliency with MiVoice Border Gateways (MBGs). See the MiCol-

lab Client for Mobile Resiliency Guide for more information.

MiCollab Client Administrator Guide

For MiVoice Business communication systems, any number dialed from the MiCollab Desktop Client that exceeds the Extension Length configured for the communication system will be automatically prefixed with the Dialing Prefix. To dial a number “as is,” start the number with a hyphen (-) character.

Table 9

provides the MiVoice Business Feature Access Codes (FACs).

Feature

Number

Table 9: MiVoice Business Supported Feature Access Codes

Feature Name

ACD Silent Monitor

ACD Agent Login

ACD Agent Logout

Make Busy Setup

Make Busy Cancel

Call Forwarding – Busy – External Only

Call Forwarding – Busy – External and Internal

Call Forwarding – Follow Me

Desk Phone









Softphone







Cancel Call Forwarding – Busy – External and

Internal

Call Forwarding – Follow Me

Cancel Call Forwarding – Follow Me

Call Forwarding – I Am Here

Call Forwarding – No Answer – External Only



Call Forwarding – No Answer – External and

Internal

Call Forwarding – No Answer – Internal Only



Cancel Call Forwarding – No Answer – External and Internal

Cancel All Forwarding

Call Hold – Remote Retrieve

Call Pickup – Dialed

Call Pickup – Directed

Do Not Disturb

Do Not Disturb – Cancel

Do Not Disturb – Cancel Remote

Do Not Disturb – Remote

Last Number Re-dial

Message Waiting – Activate



Page 1 of 2

Features

Table 9: MiVoice Business Supported Feature Access Codes (continued)

Feature

Number Feature Name

Message Waiting – Deactivate

Message Waiting – Inquire

Desk Phone



Softphone



Page 2 of 2

1. ACD Silent Monitor is supported for ACD hot desk agents on MiNET softphones only.

MiVoice Office 250 Communication platform features

Table 10

provides the MiVoice Office 250 feature matrix.

Table 10: MiVoice Office 250 PBX feature matrix

MiCollab Client

Account Code

–

All Calls Following

Feature Name

Account Code – Optional

ACD Agent Login

ACD Agent Logout

ACD Agent Login/Logout Toggle

Code

391

390

326

327

328

Desk Phone



Softphone



ACD Agent Wrap-Up Terminate

Activate Door Relay

Agent Help

Agent Help Reject

Answer (Ringing Call)

Audio Diagnostics

Automatic CO Access On/Off

Automatic IC Access On/Off

Automatic Trunk Answer

Background Music On/Off

Barge-In

Call Forward All Calls

Call Forward If Busy

Call Forward If No Answer

Call Forward If No Answer/Busy

Call Logging

329

332

375

376

351

320

360

361

350

313

386

355

357

356

358

333



























Page 1 of 3

MiCollab Client Administrator Guide

Change Language

CO Hookflash

Conference

Data

Default Phone

Directories

Table 10: MiVoice Office 250 PBX feature matrix

MiCollab Client

Feature Name

Display Outside Party Name

On/Off

Code

301

330

340

394

307

379

Desk Phone



Softphone





 3



Display Time/Date (ITP)

Show IP Address (SIP)

300





Do-Not-Disturb

Do-Not-Disturb Cancel

Do-Not-Disturb On/Off

370

371

372

 

Do-Not-Disturb Override

Dynamic Extension Express On

Dynamic Extension Express Off

Dynamic Extension Express On/Off

373

363

362

364









Dynamic Extension Express – Handoff

Enhanced Speakerphone Enable

Feature Key Default

Group Listen

Handsfree On/Off

Headset Enable

Headset Disable

Headset On/Off

388

310

395

312

319

315

316

317

















Hold – Individual

Hold – System

Hot Desk On/Off

Hunt Group Remove

Hunt Group Replace

Hunt Group Remove/Replace

LCD Contrast Adjustment

336

335

348

322

323

324

303











Message

Message – Cancel

Message – Cancel Current

365

366

368





Page 2 of 3

Features

Message – Silent

Mute On/Off

Page

Page On/Off

Program Buttons

Table 10: MiVoice Office 250 PBX feature matrix

MiCollab Client

Feature Name

Program Phone Password

Queue Request

Record-A-Call

Redial

Redirect Call

Reminder Message

Reminder Message Cancel

Code

367

314

325

397

392

385

380

331

305

306

Desk Phone



Softphone













Remote Configuration – Disable

Remote Configuration – Display License Key

Remote Configuration – Enable

Remote Configuration – Reset

Remote Programming

Reverse Transfer (Call Pick-Up)

Review Keys

Ring Intercom Always On/Off

Ring Tone Selection

Routing Off

Station Monitor

Station Speed Dial

Station Speed Dial Programming

Steal

Switch Keymap

System Forward Enable

System Forward Disable

System Forward On/Off

343

347

342

344

359

396

377

398

304

321

382

383

387

399

352

353

354































System Speed Dial

Transfer to Hold

Transfer to Ring

381

346

345











Page 3 of 3

MiCollab Client Administrator Guide

1. Account code dialing is not supported on SIP softphone.

2. This feature requires an HX Controller and MiVoice Office 250 v4.0 software.

3. Conference feature is not supported on SIP-based softphone.

4. This feature requires MiVoice Office 250 v5.0 software.

5. This feature must be completed on the phone.

Note the following for MiVoice Office 250 systems:

• Any number dialed from the MiCollab Desktop Client that is not equal to the Extension Length configured for the communication system will be automatically prefixed with the Dialing Prefix.

To dial a number “as is,” start the number with a hyphen (-) character.

• When entering feature codes in the MiCollab Desktop Client using the Quick Connector, users should enter the hyphen character (-) before the digits to indicate to the MiCollab Client Service that the digits are a feature code.

Also, some feature codes require additional digits to complete the feature. If users need to add digits following the feature code, they should first insert the hyphen character before entering the digits. For example, to use Station Monitor to monitor extension 1000, users would enter

-321-1000

in the Quick Connector.

• When entering feature codes using the Dial Pad, users can use the Special button to enter feature codes for on-call features. On call features include:

• Agent help

• Audio diagnostics

• Barge in

• Do-not-disturb override

• Group Listen

• System Hold

• Steal

• Transfer to hold

Features

About Account Synchronization

MiCollab Client supports two types of synchronization to quickly populate the MiCollab Client accounts list based on your existing PBX node, Active Directory (AD), or Lightweight Directory

Access Protocol (LDAP) corporate directory. Synchronizer types include:

• AD/LDAP Synchronizer: Using this option you can populate the MiCollab Client accounts database using the corporate AD or LDAP directory. The MiCollab Client Service can integrate with single or multiple LDAP v3-enabled directory servers to import accounts. If you intend to use AD/LDAP synchronization to import accounts into MiCollab Client, make sure your directory server supports LDAP v3. The Microsoft 2003 Server LDAP/AD server supports LDAP v3.

Note:

See the following topics in the MiCollab Client Service Administrator online help for detailed information about AD/LDAP Corporate Directory Synchronizers:

•

Synchronization Tab

•

Adding and Editing AD/LDAP Synchronizers

• PBX Node Synchronizer: Select this option if you want to populate the MiCollab Client accounts database using the user/extension information programmed for the MiVoice Business or MiVoice

Office 250 PBX.

To provide ongoing synchronization between MiCollab Client and the AD/LDAP or PBX node directories, you can schedule automatic synchronizations. You can also complete manual synchronizations for either type of synchronizer.

In addition to synchronization, you can also populate the MiCollab Client accounts list by manually creating accounts. Accounts that are created manually will automatically be configured with the default account settings.

MiCollab Client Administrator Guide

About Presence

The MiCollab Client presence feature allows users to monitor other users on the system.

Presence server

Presence is provided by the Presence Server component on MiCollab Client Service and consists of the following components which provide presence for MiCollab Client users.

• SIP Proxy: A SIP-compliant proxy server that routes all the incoming SIP requests to the correct components in MiCollab Client Service.

• SIP Subscription Manager: Abstracts the SIP SUBSCRIBE/NOTIFY semantics from the application and implements the application-specific logic.

• IM Server: Maintains state information for offline IM messages and conferences. The IM server uses the SIP Subscription Manager to track incoming SIP SUBSCRIBE requests for offline IM and conference states. The SIP Subscription Manager also sends the corresponding SIP NO-

TIFY requests to subscribers when it receives state changes from the IM Server.

Presence modes

MiCollab Client utilizes Dynamic Presence which means the MiCollab Desktop Client will automatically display presence for the contacts in the current view.

Notes:

• When the user is filtering or scrolling the contact list there may be a brief delay between when the contact is displayed and when the presence for the contact is displayed. This delay is the amount of time it takes for the client to request the presence from the server and for the server to respond with the presence updates. This delay is minimal, however there are certain conditions like server load which may increase this delay.

• Users who are licensed for the Console Option will work in much the same way as the main contact list. The client will only subscribe to presence for contacts that are visible. Refer console users to the Contacts Context Menu topic in the MiCollab Desktop Client online help for instructions about showing and hiding presence for contacts.

Features

Types of presence

When the Presence licensed feature is enabled for a user, the following information is displayed in the MiCollab Desktop Client Contacts view for MiCollab Client contacts:

• Dynamic Status: Incorporates the following elements to provide status and availability information for MiCollab Client users:

• Dynamic Status Name: Provides a simple description for the Dynamic Status.

• Default message/custom text: Provides additional information for the selected Dynamic

Status.

• Calendar advisory text: Provides advisory messages that indicate a user's calendar availability timing summary based on their Google, Outlook, Lotus Notes, Office 365, or Exchange calendar entries (for example, “In appointment until 2:30 PM”, “Free until 11 AM”).

Note:

By default, all users who log in to MiCollab Client are provided with a list of default Dynamic

Statuses. The Status unknown message indicates that the contact has not logged in to

MiCollab Client.

• Telephony presence: The following icons indicate telephony presence for MiCollab Client corporate and peered contacts:

• Indicates that the contact's phone is idle.

•

• Indicates the contact's phone is ringing.

Indicates that the contact is on hold.

Indicates that the contact's phone is busy or has enabled Do-Not-disturb.

Indicates that the contact’s telephony presence is offline.

• MiCollab Client chat presence: The following icons indicate chat presence for corporate and federated contacts:

•

• Indicates that the contact is online and available for chat.

Indicates that the contact is away from his or her computer.

• No icon is present when the contact is offline.

Note:

The icons above are also used to display IM presence for federated contacts (see

“Federation” on page 26 ).

• Video presence: MiCollab Client displays presence icons for corporate contacts who are configured to engage in video calls:

• Indicates that the contact is currently accepting video calls.

• No icon indicates that the contact is offline for video.

MiCollab Client Administrator Guide

Dynamic Status

Dynamic Status provides a way for the user to control and communicate their presence and availability, and customize their call routing. MiCollab Client provides default Dynamic Statuses as

per Table 11 Dynamic Status defaults . The user can add, edit, and delete Dynamic Statuses as

needed on their individual clients (for example, see Manage Statuses on MiCollab Desktop Client).

Notes:

•

Softphone or deskphone 2 is treated as Home IP phone.

•

Additional EHDU numbers (after the first one) are not taken into account in the setting of dynamic statuses.

•

The above logic is executed only when the account has no account statuses defined in the account status table in MiCollab Client Service. The account will be in this default state of 'no statuses' until the user connects to MiCollab Client Service from one of the MiCollab Client s, the very first time.

•

If account has 1 or more valid account status, changes in account's phone numbers or adding voicemail number later will not create additional statuses.

•

The web service call to create the default account statuses will also create the favorites and loginNotify group for that account. The loginNotify group is created if it did not exist before.

The favorites group is created if no user defined groups exists for that account.

Table 11: Dynamic Status defaults

Phone Configuration

In the office Mobile

Working from home

Deskphone and no Voicemail number

Deskphone and has Voicemail number

Deskphone, softphone and no Voicemail

EHDU Deskphone and no Voicemail number

Deskphone, Softphone and Voicemail number

Deskphone, Softphone, EHDU number and

Voicemail (need PRG)

Deskphone1, Deskphone2, EHDU and

Voicemail (need PRG)

Deskpohne1, Deskphone2 and Voicemail

Do not

Disturb

Gone for the day

Features

About Collaboration

Mitel supports the MiCollab Audio, Web, and Video Conferencing - formerly known as Mitel

Collaboration Advanced (MCA) product to provide integrated collaboration features to MiCollab

Client users. MiCollab Audio, Web and Video Conferencing collaboration features include video calls, audio conferences, web conferences, and other tools such as desktop and application sharing, whiteboarding, and annotation.

The collaboration server is the central hub for all conference sessions. Conferences require a server where the conference sessions are hosted, and all conference information flows through the server before being distributed to the MiCollab Desktop Client.

MiCollab Audio, Web and Video Conferencing is packaged on the MiCollab server, which is connected to the IP network. The MiCollab server provides access to a Web-based administrator interface for configuring MiCollab Audio, Web and Video Conferencing, scheduling conferences, viewing conference calls, and administering collaboration controls. Users can access all interfaces through either HTTP or HTTPS.

For product information for MiCollab Audio, Web and Video Conferencing, see the MiCollab

Installation and Maintenance Manual on the Mitel eDocs Web site (http://edocs.mitel.com).

Note the following when implementing collaboration integration for MiCollab Client:

• To use collaboration features users must be licensed for the Collaboration Integration feature

(see

Table 2 on page 22 ).

• If users receive a licensing error message when attempting to use collaboration features, you may need to increase the number of collaboration port licenses for the MiCollab Audio, Web and

Video Conferencing collaboration server.

• The MiCollab Client Service does not control the user limit for the collaboration servers. This is handled by the MiCollab Audio, Web and Video Conferencing collaboration server.

• You can configure only one default MiCollab Audio, Web and Video Conferencing server. If more than one Collaboration server is in use at the site, you must specify which MiCollab Audio, Web and Video Conferencing server should be used on a per-account basis in the MiCollab Client

Service Administrator interface (see

page 107 ).

• MiCollab Client v7.0 requires MiCollab Audio, Web and Video Conferencing 5.0 or later. Earlier versions of MiCollab Audio, Web and Video Conferencing or AWC are not compatible with

MiCollab Client v7.0.

MiCollab Client Administrator Guide

About SIP

MiCollab Client supports SIP - Session Initiation Protocol. MiCollab Desktop Client as well as Mobile

Clients (Android and iPhone) all support a SIP softphone and can operate with MiVoice Conference

Phone devices and MiCollab Audio, Web and Video Conferencing. In addition, MiCollab Client is capable of operating with a number of third party SIP Servers and SIP end points such as SIP phones, Audio Conference Units and Video Conference Units.

Mitel maintains a SIP Centre of Excellence (SIP CoE); the CoE performs interoperability testing between third party devices and Mitel SIP devices. The CoE generates documents that cover the results of the interoperability tests and how the devices should be configured for successful interoperation.

For the complete list of devices that can interoperate with please see Knowledge Base article called the SIP Technical Reference Guide 08-5159-00014. This Reference Guide can be found on Mitel

On-Line under ‘Support’ and then under ‘Mitel Knowledge Base’.

Features

About OfficeLink

MiCollab Client 3.2 and later includes the OfficeLink feature. Using this feature, users can place calls from the devices configured for them on the PBX from MiCollab Web Portal.

PBX software requirements

Supported device types and OfficeLink functionality are determined by the following factors:

• The PBX that is connected to the MiCollab Client Service

• The software version running on the PBX

At a minimum, the MiCollab Client OfficeLink feature requires the following PBX system software:

• MiVoice Business v4.2 or later

• MiVoice Office 250 v4.0 or later

Note:

OfficeLink is currently not supported on the MiVoice 5000 and MiVoice MX-One platforms.

Devices must be configured as follows in the PBX programming application to be available for use with the MiCollab Client OfficeLink feature:

• MiVoice Business System Administration Tool: MiCollab Client users can use devices configured in the user's Personal Ring Group (PRG) for the OfficeLink and Multi-Device User Group

(MDUG) features.

Note:

Multi-Device User Groups are supported for MiVoice Business 5.0 and later ONLY.

PRGs are an association of two or more devices for a single user under a common Directory

Number (DN). Complete the following programming from the v4.0 or later MiVoice Business

System Administration Tool for the OfficeLink feature:

•

Configure PRGs using the Personal Ring Group Assignment form. See page 85 for details.

• If required, define a DN to be used as the prime member of the PRG using the Multiline IP

Set Configuration form. See page 84 for details.

• Complete these same fields from the 5.0 or later MiVoice Business system Administration

Tool for the OfficeLink feature for either PRG or MDUG. See page 84 for details.

• MiVoice Office 250 Database Programming: MiCollab Client users can use devices configured as the user's Associated Destinations for the OfficeLink feature. Associated Destinations provide advanced call routing capabilities for the PBX and MiCollab Client. Complete the following programming from MiVoice Office 250 DB Programming for the OfficeLink feature:

• Configure the fields and options for the user in the Users folder (Users -<User>). See

“Users” on page 88 for details.

• For MiVoice Office 250 v5.0 and later systems, configure the OfficeLink Assistant (System

-Devices and Feature Codes - Assistants). See

“System – devices and feature codes –

Assistants” on page 87 for details.

MiCollab Client Administrator Guide

If you are using PBX synchronization to populate the MiCollab Client account database, after programming the PBX as described above you will need to complete a manual PBX synchronization from the MiCollab Client Service Administrator interface (PBX Nodes tab) to provide OfficeLink functionality to MiCollab Client accounts.

Supported device types

Depending on the PBX and the software version running on the PBX, the following device types can be used with the MiCollab Client OfficeLink feature:

• Desk phones: Includes the list of supported desk phones (see

Table 13 on page 70

) for the following PBXs:

• MiVoice Business v4.2 and later

• MiVoice Office 250 v3.2 and later

• Softphones: Includes the MiCollab Client softphone for the following PBXs:

• MiVoice Business v4.2 and later (5.0 SP2 required for SIP softphones)

• MiVoice Office 250 v3.2 and later (5.1 or later for SIP softphones)

• External Devices: Includes external devices (for example, mobile devices) that meet the following requirements:

• MiVoice Business v4.1 and later: OfficeLink calls are allowed from external devices that are logged in to the user's External Hot Desk User (EHDU) extension.

• MiVoice Office 250 v5.0 and later: OfficeLink calls are allowed from external devices programmed as a user's Associated Destination.

Note:

The OfficeLink feature is not supported for external devices in the MiVoice Business v4.0, and

MiVoice Office 250 v4.0 PBXs.

• SIP Devices: Includes SIP devices connected to an MiVoice Business 5.0 SP2 or later system.

Note:

The OfficeLink feature is not supported for MiVoice Office 250 SIP devices.

OfficeLink functionality

When users access the OfficeLink feature , the Place OfficeLink Call dialog box appears. The example below shows the Place OfficeLink Call dialog box from the BlackBerry.

Figure 0-5

Features

Figure 6: BlackBerry Place OfficeLink call dialog box

From the Place OfficeLink Call dialog box, users must specify the following:

• The number to call

• The device to place the call from

When users activate the OfficeLink feature, the response from the PBX varies based on the software version running on the PBX and the device the user has selected.

Table 12 PBX Response to OfficeLink feature

provides the PBX responses which include:

• Click to Call: The PBX immediately places a call to the specified number from the specified device. This behavior is also known as Click to Call.

• Remote Click to Call: The PBX places a call to the device the user selected. After the user answers the call on the device, the PBX immediately places a call to the specified number. This behavior is also known as Remote Click to Call.

Note:

Devices marked as Not Applicable (N/A) are not supported OfficeLink device types for the

PBX software version.

PBX

MiVoice

Business

MiVoice Office

250

Table 12: PBX Response to OfficeLink feature

Device

Software

Version

4.0

4.1 and later

4.0

5.0 and later

Desk Phone

Softphone External Device SIP Device

Click to Call Click to Call N/A N/A

Click to Call Click to Call Remote Click to Call Remote Click to Call

Click to Call Click to Call N/A N/A

Click to Call Click to Call Remote Click to Call N/A

MiCollab Client Administrator Guide

Basic Bundle

MiCollab Desktop Client and MiCollab Web Portal can be configured as a basic client using the default MiCollab Client profile.

Administration

Administer the Basic MiCollab Client feature using the portal features tab in MiCollab Client Service administration.

On the MiCollab Client Service, if an account is assigned the Default Profile, it will be treated as a

Basic MiCollab Client account. In other words, users will only have access to the allowed features list below.

MiCollab Desktop Client and MiCollab Web Portal Impact

Only default profile features listed below are supported.

Licensing

No impact.

Allowed features

MiCollab Client Service will pass the following list of allowed features to the MiCollab Desktop Client or MiCollab Web Portal on login:

Allowed Features

Auto Answer

Blind Transfer

Call Forwarding

Chat

Click to Call from

MiCollab Client

contacts

Compact Mode

Contact Groups

Corporate Contact

Desk Phone Button Programming

Do Not Disturb

External Dial

Import Contacts (Google and Outlook)

Missed Call Logs

Make and Receive Call

RSS Window

Visual Voice Mail

MiCollab MAC

Desktop Client

MiCollab Desktop

Client

MiCollab Web

Portal

Features

Entry Bundle

MiCollab Desktop Client and MiCollab Web Portal can be configured as an entry level client using the default MiCollab Client profile.

Administration

Administer the Entry MiCollab Client feature using the portal features tab in MiCollab Client Service administration.

On the MiCollab Client Service, if an account is assigned the Default Profile, it will be treated as an

Entry MiCollab Client account. In other words, users will only have access to the allowed features list below.

MiCollab Desktop Client and MiCollab Web Portal Impact

Only default profile features listed below are supported.

Licensing

Entry bundle licensing

Allowed features

MiCollab Client Service will pass the following list of allowed features to the MiCollab Desktop Client or MiCollab Web Portal on login:

Allowed Features

Auto Answer

Blind Transfer

Call Forwarding

Call History

Chat

Click to Call from MiCollab Client contacts

Compact Mode

Contact Groups

Corporate Contact

Desk Phone Button Programming

Do Not Disturb

External Dial

Hotdesking

Import Contacts (Google and Outlook)

Knowledge management

Make and Receive Call

MiCollab MAC

Desktop Client

Missed calls

MiCollab

Desktop Client

MiCollab Web

Client

MiCollab Client Administrator Guide

Allowed Features

Presence (IM, voice and video)

RSS Window

Visual Voice Mail

MiCollab MAC

Desktop Client

MiCollab

Desktop Client

MiCollab Web

Client

Features

Teamwork Mode

Teamwork Mode provides the ability for a user to have certain MiCollab Client functions without having a Mitel phone. In other words, a user will still be able to use certain non-telephony based features within the client even though the user does not have a desk phone or softphone.

Licensing

There are no new or additional licenses required specific to the Teamwork Mode feature.

Licenses for individual features such as Chat, Visual Voicemail, etc...are still required.

Client impacts

Since Teamwork Mode users have no devices associated with their account, telephony specific features will be hidden or not available on the following clients:

• MiCollab Desktop Client

• MiCollab for Mobile

• MiCollab Web Portal

However, features such as contact grouping, presence, dynamic status and chat are supported.

User interface

Teamwork Mode is not something the user can change and therefore there will be no indication that the user is running in Teamwork Mode. A user in Teamwork Mode will still appear in the contact list of other MiCollab Client s but without telephony presence. In addition, a user in Teamwork Mode will still be able to see the telephony presence of other contacts if these are available.

Routing information

The main screen on all mobile and web clients displays routing information for the user’s current status. This section will be hidden for users in Teamwork Mode.

OfficeLink

OfficeLink functionality will be hidden from the user in Teamwork Mode. However, native dialing will still be available from the various clients, for example a BlackBerry user is still able to use the

BlackBerry Smart Dialing feature to call other MiCollab Client users from the Company Directory.

Call History

The Call History feature will be hidden for Teamwork Mode users.

MiCollab Client Administrator Guide

MiCollab Client for VMware Horizon view

MiCollab Client version 5.0 introduced support for VMware Horizon View. MiCollab Client for VMware

Horizon View now enables a MiCollab Client softphone to function as a plug-in to VMware View virtual desktops.

For more information about supported versions and features, see the Virtual Appliance Deployment

Solutions Guide.

The following are the supported VMware Horizon View configuration attributes:

• Linked-Clone virtual desktop pools

• Dedicated-Assignment desktop pools

• Floating-Assignment desktop pools

• Full VM desktop

• View Persona Management

Notes:

•

Floating-Assignment desktop with View Persona Management is strongly recommended.

However, there are situations where View Persona Management is not desirable, for example, where the administrator want all data to be wiped clean between sessions (eg. kiosk, guest access).

•

Local mode and Windows Roaming Profile are NOT supported.

MiCollab Client Direct Media

With MiCollab Client Direct Media architecture, the real-time sensitive media path flows directly between any two endpoints. It does not need to be processed in the VDI (Virtual Desktop

Infrastructure) back end or traverse the WAN/Internet paths between the endpoints and the backend.

This architecture prevents “tromboning” which has scalability issues resulting from a topology requiring extensive VDI backend use.

Referring to

Figure 7 on page 67 , the basic system consists of:

• A collection of View virtual desktops, managed by the View Connection Server

• VMware Horizon View Connection Server - this manages the View sessions

• A collection of physical endpoints (Thin Clients / PC’s running View Client), used to present the virtual desktop to the end user

• VMware Horizon View Agent software

• VMware Horizon View Client software

• MiVoice Business

• MiCollab Client Service

• MiCollab Client in the View environment, this resides in the virtual desktop

Features

• MiCollab Client Plugin, installed in the physical endpoint in the View environment, this contains the media portion of the MiCollab Client and handles the actual media streaming.

Note: The version of MiCollab Client Plugin installed in the physical endpoint device must align with the version of the MiCollab Client installed in the virtual desktop for correct functioning of MiCollab

Client on VMware Horizon View. For more information, see the MiCollab Client Release Notes.

The View media services API, running over the PCoIP side channel to the View client, is used to control media functions of the MiCollab Client Plugin in the physical client device.

See the Virtual Appliance Deployment Solutions Guide for version and feature support.

Figure 7: Flat network topology

In a more complex architecture shown in

Figure 8 on page 68

below, MiVoice Border Gateways can be used to include remote users such as a branch or small office into the VMware Horizon view solution. A network DMZ configuration is used to contain the PCoIP Secure Gateway (also known as Security Server) and Border Gateway components.

MiCollab Client Administrator Guide

Figure 8: Remote Office / Hosted Office topology

More complex configurations are possible. For more information, see the MiCollab Client

Engineering Guidelines.

Chapter 3 Specifications

MiCollab Client Administrator Guide

Introduction

This chapter provides system hardware and software requirements, capacities, and network guidelines for MiCollab Client installations.

System requirements

This section provides the system hardware and software requirements for MiCollab Client.

PBX requirements

To use MiCollab Client, integrated users must have either a desk phone, softphone or both configured on one of the following Mitel communication platforms and versions:

• MiVoice Business v4.2 or later (5.0 SP2 is required for SIP softphone)

MiVoice Business 7.0 with latest SP is recommended.

• MiVoice Office 250 v3.2 or later (5.1 is required for SIP softphone)

MiVoice Office 250 6.0 with latest SP is recommended.

When deployed in a MiCollab environment, MiCollab Client can also be integrated with:

• MiVoice 5000 Release 6.1: The MiVoice 5000 call processing software is configured through the MiVoice 5000 administrator interface.

• MiVoice MX-One Release 6.0 SP1: The MiVoice MX-One call processing software is configured through the MiVoice MX-One administrator interface.

This guide assumes that you are familiar with the programming interface for the PBX installed on site. MiCollab Client requires certain fields and options be programmed correctly for the PBX to provide integration with the communication platform. Programming interfaces include:

• MiVoice Business System Administration Tool

• MiVoice Office 250 Database (DB) Programming

Table 13 Supported Mitel Phones

provides the list of supported desk phones for MiCollab Client. In the following table, supported phones are indicated by

and phones not supported are indicated by



For MiVoice 5000, see the MiVoice 5000 Product - Version Compatibility guide for a list of supported phones.

5005 IP Phone

Table 13: Supported Mitel Phones

Mitel Phone Model

4015 Digital Telephone

4025 Digital Telephone

4150 Digital Telephone

MiVoice Business PBX



MiVoice Office 250 PBX



Page 1 of 3

Specifications

Table 13: Supported Mitel Phones (continued)

Mitel Phone Model

5010 IP Phone

5020 IP Phone

5140 Digital Telephone

5212 IP Phone

5215 IP Phone

5220 IP Phone

5224 IP Phone

5304 IP Phone

5312 IP Phone

5320 IP Phone

5324 IP Phone

5330 IP Phone

5340 IP Phone

5360 IP Phone

5602 SIP Phone

5603 SIP Phone

5604 SIP Phone

5606 SIP Phone

5607 SIP Phone

5610 SIP Phone

8520 Digital Telephone

8528 Digital Telephone

8560 Digital Telephone

8568 Digital Telephone

8620-2 IP Phone

8622 IP Phone

8660 IP Phone

8662 IP Phone

IP Plus

IPSLA

Navigator IP Phone

MiVoice Business PBX MiVoice Office 250 PBX





































Page 2 of 3

MiCollab Client Administrator Guide

Table 13: Supported Mitel Phones (continued)

Mitel Phone Model

Turret

MiVoice Business PBX



MiVoice Office 250 PBX



Page 3 of 3

Note:

SIP phones support a limited PBX feature set.

MiCollab Client Service requirements

MiCollab Client provides two options for the MiCollab Client Service component:

• MiCollab Client Software: Includes the MiCollab Client Service software blade. This option requires the customer to:

• Purchase and install a Mitel Standard Linux

(MSL) approved hardware platform.

• Download, install, and configure the MSL operating system on the hardware platform.

• Download, install, and configure the MiCollab Client software blade on the hardware platform.

• MiCollab Client Virtual Appliance: Includes the packaged MSL operating system and MiCollab

Client Service software in an Open Virtualization Format (OVA) file. This option requires the customer to purchase a virtualization license and install the virtual appliance in a pre-established

VMware environment. Note that the MiCollab Client application is also included as part of the

MiCollab virtual appliance as of MiCollab version 3.0.

Requirements for the standalone MiCollab Client Service virtual appliance are listed in the Virtual

Appliance Deployment Solutions Guide.

About virtualization

MiCollab Client Service is provided in virtual appliance form for customers who have an established

VMware environment in place. The virtual appliance includes the MSL operating system and the

MiCollab Client Service software blade. Running the MiCollab Client Service within a VMware environment requires a license that allows usage in a virtualized environment. For more information, see the Virtual Appliance Deployment Solutions Guide.

For more information about the VMware vSphere infrastructure, ESX, and ESXi, see the VMware documentation available on the VMware Web site (http://www.vmware.com).

Specifications

Mitel Integrated Application requirements

The following Mitel applications can be integrated with the MiCollab Client installation:

• MiCollab UM Voice Mail application, v4.0 or later (MiVoice Business and MiVoice Office 250 only)

• MiCollab Audio, Web, and Video Conferencing (formerly known as Mitel Collaboration Advanced) application, v4.0 or later

• MiVoice Border Gateway, v8.0 SP2 or later (MiVoice Business only)

Basic server requirements for the integrated Mitel applications are listed in Table 14 Mitel Integrated

Applications Server Requirements

Table 14: Mitel Integrated Applications Server Requirements

Component Requirement Version

Hardware Platform

Operating System

An approved MSL hardware platform. See the

Application/MSL Matrix available on Mitel Online for a list of approved hardware platforms.

MSL v10.3

Most of the Mitel applications listed above are integrated components of MiCollab. Each application may include application-specific client and server requirements. See the individual application documentation for application-specific requirements. All Mitel applications are licensed though the

Mitel Application Management Center (AMC).

Documentation for MSL, MiCollab, and the integrated applications listed above is available on the

Mitel eDocs Web site (http://edocs.mitel.com).

MiCollab Desktop Client requirements

The MiCollab Desktop Client is installed on users’ computers at the site. Table 15 MiCollab Desktop

Client Requirements

provides the computer hardware and software requirements for the MiCollab

Desktop Client.

Table 15: MiCollab Desktop Client Requirements

Component

Central Processing Unit

(CPU)

Available Hard Disk Space

Requirement

1.6 GHz or faster

100 MB free hard disk space

Dual Core

Version

Random Access Memory

(RAM)

2 GB RAM minimum

(4 GB or more recommended)

Network Interface Card (NIC) Full duplex 10/100/1000 Mbps

(100 Mbps full duplex recommended)

Sound Card Full duplex

MiCollab Client Administrator Guide

Table 15: MiCollab Desktop Client Requirements (continued)

Component

Operating System (OS)

Requirement

Microsoft Windows Vista

Version

Business/ Enterprise/Ultimate

Service Pack 2

32 or 64-bit

Microsoft Windows 7

Microsoft Windows 8

Professional/Enterprise/Ultimate

32 or 64-bit

Desktop mode only

32 or 64-bit

Microsoft Office

Application(s)

Thin Clients

Office 2007, Office 2010,

Office 2013, Office 365

Citrix

XenApp

Client

Remote Desktop Services

(formerly Windows Terminal

Services WTS)

6.0, 6.5, 7.0, 7.5, or 7.6 v6.1 (Installed as part of

Windows Server 2008 R2)

*Windows Terminal Services

2012 is supported as of

MiCollab Client

6.0

4.6, 5.0

, 5.1 or 5.2

Digital Media Player

VMware Horizon View

Windows Media

Player 6 or later

Microsoft Add-on Microsoft.NET™ Framework 4.0, 4.5

1. Citrix and WTS are supported for desktop phone operation. Citrix Xenapp 7.6 SP3 and above is required for the SIP softphone. WTS does not support the softphone.

Citrix and WTS do not support video call features.

2. VMware Horizon View 4.6 and later are supported for desktop phone operation.VMware Horizon View 5.0 and later supports softphone operation.

Notes:

WTS deployment:

•

The CAL licenses should be Per User Licenses and not Per Device License.

•

Initially, upon user login, there may be a spike observed in CPU Usage. This is an expected behavior and the usage should lower after a period of time. This behavior is applicable to both

MiCollab Desktop Client and MiVoice for Skype for Business.

Citrix deployment:

•

MiCollab Desktop Client and MiVoice for Skype for Business support Citrix XenApp only.

The MiCollab Desktop Client includes an embedded softphone. The user requires the following to use the embedded softphone:

•

The softphone license provisioned for the user’s account (see Table 2 on page 22

)

•

A programmed extension for the user on the PBX (see page 83)

Specifications

• A supported headset or handset

Note:

Effective in MiCollab Client 6.0 SP2, when selecting Plantronics headsets under MiCollab Desktop

Client Softphone Settings, some functionality are pre-defined (no additional configuration required). The software (known as SPOKES) should download automatically to your PC. If required, go to https://www.plantronics.com/us/support/software-downloads/spokes-2.jsp

and select Download (Windows) to manually download).

See the MiCollab Client 7.0 Engineering Guidelines for a list of tested devices.

MiCollab MAC Desktop Client requirements

The MiCollab MAC Desktop Client is installed on the computers at the site. Table 16 MiCollab MAC

Desktop Client Requirements provides the computer hardware and software requirements for the

MiCollab MAC Desktop Client

Table 16: MiCollab MAC Desktop Client Requirements

Component

Central Processing Unit

(CPU)

Available Hard Disk Space

Requirement

1.6 GHz or faster

100 MB free hard disk space

Dual Core

Version

Random Access Memory

(RAM)

2 GB RAM minimum

(4 GB or more recommended)

Network Interface Card (NIC) Full duplex 10/100/1000 Mbps

(100 Mbps full duplex recommended)

Sound Card

Operating System (OS)

Full duplex

MiCollab Web Client requirements

The MiCollab Web Client provides remote access to a subset of MiCollab Client features from one of the following supported computer Web browsers:

• Microsoft Internet Explorer

(IE) 10 or later (see note)

• Mozilla

Firefox

14 or later

• Apple

Safari 5.6, 6.0 or later

• Google Chrome™ 21 or later

Note:

IE8 or IE9 users could use the Google Chrome Frame plug-in to get real-time data and have chat, presence and call control functionality. However, the plug-in will no longer be updated and supported effective Jan 2014. The plug-in will continue to work if you already have it installed otherwise upgrade to IE10 or later to get all the functionality.

MiCollab Client Administrator Guide

MiCollab for Mobile for requirements

MiCollab for Mobile is a stand-alone client that users install on their mobile device. MiCollab for

Mobile provides an integrated environment in which you can communicate with corporate contacts, and access and manage visual voice mail and call history.

MiCollab for Mobile is supported on the following devices:

Device

BlackBerry

Android iPhone

Windows 8 phone

Windows 10 phone

Requirement

OS version 10.2.2.x or later

OS version 5.0 or later

OS version 8.0, 8.1, 8.2, 8.3, 9.0 or later

OS version 8.0, 8.1, 8.2, 8.3 or later

OS version

MiVoice for Skype for Business requirements

MiVoice for Skype for Business is installed on users’ computers. Table 17 MiVoice for Skype for

Business Requirements provides the computer hardware and software requirements.

Table 17: MiVoice for Skype for Business Requirements

Component Requirement Version

Dual Core Central Processing Unit

(CPU)

Available Hard Disk Space

Random Access Memory

(RAM)

1.6 GHz or faster

100 MB free hard disk space

2 GB RAM minimum

(4 GB or more recommended)

Network Interface Card (NIC) Full duplex 10/100/1000 Mbps

(100 Mbps full duplex recommended)

Operating System (OS) Microsoft Windows Vista

Microsoft Windows 7

Microsoft Windows 8

Business/ Enterprise/Ultimate

Service Pack 2

32 or 64 bit

Professional/Enterprise/Ultimate

32 or 64 bit

Desktop Mode only

32 or 64 bit

Server

Microsoft Office

Application(s)

Microsoft Add-on

MiVoice for Skype for Business,

Lync 2010 or 2013

Office 2010,

Office 2013, Office 365

Microsoft.NET Framework 4.0, 4.5

Specifications

Note:

MiVoice for Skype for Business in a MiVoice for Office deployment supports 85xx and 86xx sets.

Optional third-party client components

See “Optional third-party integrated applications” on page 17.

MiCollab Client Administrator Guide

PBX node environments

The MiCollab Client site’s PBX provides call control for MiCollab Client local and remote users. The following PBX configurations are supported for MiCollab Client:

• Single MiVoice Business/ MiVoice Office 250/PBX Node

• Multiple MiVoice Business/ MiVoice Office 250/PBX Nodes

• Multiple mixed MiVoice Business/MiVoice Office 250/PBX Nodes

MiCollab Client Service is capable of communicating with multiple PBXs to provide a global view for the MiCollab Client clients. Call commands from the MiCollab Client interface to the server are directed to the respective PBX by the MiCollab Client Service based on which PBX the account resides.

A single MiCollab Client Service can support MiVoice Business, MiVoice Office 250, and PBX nodes.

However, in the MiCollab Client Service Administrator Interface, a single enterprise can be configured with just one PBX type.

Multiple mixed PBX type environments are only supported within the same company and require a separate enterprise per PBX type.

Note:

If you need to delete a PBX node with 5,000 users, you need to delete the users first and then you can delete the PBX node.

Chapter 4 Installation and Configuration

MiCollab Client Administrator Guide

Introduction

This chapter describes how to install and configure MiCollab Client.

Planning considerations

Before implementing the MiCollab Client installation, make sure the site has the required hardware, software, licensing (AMC Application Record), and virtualized environment (if the virtual appliance is used).

Note:

A trusted third party SSL certificate is required for MiCollab Client Deployment. Install the certificate on the MBG in the DMZ and on the MiCollab on the LAN. See Manage Web Server Certificate in the MSL help file for more information.

Also, determine the following:

• Which communications platform (see

“Supported Communication Platforms (PBXs)” on page 16

) are you connecting to (MiVoice Business or MiVoice Office 250)?

• Which type of synchronization (see

“About Account Synchronization” on page 53

) do you want to use to create accounts (PBX node or AD/LDAP)? You can also manually create accounts.

Note:

The MiCollab Client Service can integrate with single or multiple LDAP v3-enabled directory servers to import accounts. If you intend to use AD/LDAP synchronization to import accounts into MiCollab Client, make sure your directory server supports LDAP v3.

• How will remote users connect to the MiCollab Client Service? Options include:

• Teleworker mode (MiVoice Border Gateway and Remote Proxy Services) for MiVoice Busi-

ness users (see page 93).

• Firewall ports for MiVoice Office 250 users (see the Mitel MiCollab Client Engineering Guide-

lines for details).

• Virtual Private Network (VPN) connection.

• Which Mitel applications will be integrated with MiCollab Client (e.g., MiCollab UM, MiCollab

Audio, Web and Video Conferencing, MiVoice Border Gateway, etc.)? Several features (Video

Calls, Collaboration, Visual Voice Mail, MiCollab Client Service Peering, Federation, etc.) require you to configure the associated servers.

Do the following for all integrated applications:

• Make sure that you have downloaded all of the documentation for each product. The individual application documentation includes detailed hardware, software, and licensing requirements as well as installation and configuration instructions.

• Make sure that you have completed the required configuration for each server before starting the MiCollab Client installation.

• Review all of the planning information, including the detailed port diagrams, provided in the

MiCollab Client Engineering Guidelines.

Installation and Configuration

• Which MiCollab Client licensed features does the customer want to purchase and activate in the AMC? Make sure all licenses are purchased before you begin the MiCollab Client installation.

Note: All the MiCollab Client s - desktop, web and mobile - use secure connection for signalling and need valid certificates on the MiCollab Client Service.

High level installation and configuration procedures

The high-level procedure for installing and configuring MiCollab Client is provided below. This procedure applies to installations and to upgrades from MiCollab Client 2.0 and Your Assistant 5.1.

Note: The installation and configuration information in this chapter is MiCollab Client-specific. It does not include complete installation and configuration information for MSL, MiCollab, and the

Mitel applications that can be integrated with MiCollab Client. For product-specific documentation, see the appropriate documentation on the Mitel eDocs Web site (http://edocs.mitel.com).

To install and configure MiCollab Client, complete the following high-level steps:

Configure the PBX for MiCollab Client using one of the following programming interfaces:

• System Administration Tool for the MiVoice Business PBX (see

“MiVoice Business PBX” on page 83 ).

•

DB Programming for the MiVoice Office 250 PBX (see “MiVoice Office 250 PBX” on page 85 ).

Install and configure the integrated Mitel applications:

• If required, install and configure MiCollab UM, MiCollab Audio, Web and Video Conferencing, and MiCollab for Mobile (see

“MiVoice MX-One PBX” on page 89 ).

• If required, install and configure MiVoice Border Gateway and Remote Proxy Services (see

“MiVoice Border Gateway and Remote Proxy Services configuration” on page 93 ).

Install and configure MSL and MiCollab Client Service (see

“Install and configure MSL and

MiCollab Client Service” on page 96 ).

Access the MiCollab Client Service Administration page (see

“Access the MiCollab Client Service administration page” on page 106 ).

Provision MiCollab Client as documented in the MiCollab Client Service Administrator online

help (see “Provision MiCollab Client” on page 107

Install MiCollab Desktop Clients (see

“Install the MiCollab Desktop Client” on page 109 ).

Install MiVoice for Skype for Business Clients (see

“Install MiVoice for Skype for Business Client” on page 118 ).

Install and deploy the MiCollab for Mobile Client (see “Deploy MiCollab for Mobile Client” on page 120 ).

Configure access for remote users. Configuration procedures differ based on PBX:

• For remote users connected to the MiVoice Business PBX, see

“MiVoice Business PBX

Configuration for remote users” on page 121

• For remote users connected to a MiVoice Office 250 PBX, see

“MiVoice Office 250 PBX configuration for remote users” on page 124

10. See

“Softphone (SIP-based) specific considerations” on page 124 .

Individual client configuration and testing instructions can be found:

MiCollab Client Administrator Guide

•

“Softphone Configuration - MiCollab Desktop Client” on page 127

Installation and Configuration

Configure the PBX

This section describes how to configure the MiVoice Business and MiVoice Office 250 PBXs for

MiCollab Client.

This section assumes that you are familiar with the programming interface for the PBX installed on site. MiCollab Client requires certain fields and options be programmed correctly for the PBX to provide integration with the communication platform. Programming interfaces include:

• MiVoice Business Administration Tool

• MiVoice Office 250 Database (DB) Programming

For additional PBX programming documentation, see the PBX programming interface online help and the supplemental PBX documentation on the Mitel eDocs Web site (http://edocs.mitel.com).

MiVoice Business PBX

All the required configuration to support MiCollab Client for the MiVoice Business PBX is completed using the MiVoice Business System Administration Tool. The information in this section provides guidelines for MiCollab Client -specific configuration only.

The following MiVoice Business System Administrator Tool forms include MiCollab Client-specific fields and options:

•

“User Configuration form” on page 84

•

“License and Option Selection form” on page 84

•

“Class of Service Options form” on page 84

•

“Personal Ring Group Assignment form” on page 85

Note the following for MiVoice Business PBXs:

• The primary MiVoice Business should be up and running when MiCollab Client Service starts.

If the primary MiVoice Business is not up and running at the time of MiCollab Client Service startup, the Mitai monitors for non-resilient devices are not set and the user cannot control these devices from their MiCollab Client. Select the Refresh line monitors on save option in Account details to restart the Mitai monitor and receive updated line configuration from MiVoice Business.

See the Adding and Editing Accounts help topics for details.

• For sites that intend to use ACD PBX features in MiCollab Client, MiCollab Client supports ACD traditional agents only.

• For sites that intend to use the PBX node synchronization method for creating accounts in

MiCollab Client, special programming may be required if multiple directory number (DN) records with the same name exist on the PBX. Typically, when MiCollab Client encounters multiple records with the same name during a synchronization with the MiVoice Business PBX, only the highest directory number (DN) is brought over to MiCollab Client. To ensure that all records are included during a synchronization, DNs that share the same name require a unique entry in the

Department or Location fields. See the User Configuration and Device Configuration forms online help topics for details.

MiCollab Client Administrator Guide

• The MiVoice Business system must be running system software v4.2 or later for remote click to call OfficeLink functionality (see

Table 12 on page 61 ).

• The MiVoice Business must be running v5.0 SP2 or later for SIP softphone functionality.

• The MBG must be used when using remote SIP softphones connected to MiVoice Business.

• When you make changes to the PBX configuration, you will need to complete a manual synchronization from the MiCollab Client Service Administrator interface to import those changes to MiCollab Client (see

“License and PBX changes” on page 172 ).

Note: Only Mitel MiVoice Business-certified personnel can configure the MiVoice Business

PBX.

User Configuration form

The MiCollab Client Minet softphone must be programmed correctly in the MiVoice Business system.

In the User Configuration form (MiVoice Business v4.1 or later), in order to have resiliency the

MiCollab Client Minet softphone must be programmed on the MiVoice Business as 5020 IP set

type.

License and Option Selection form

In the License and Option Selection form, set the MiTAI Computer Integration option to Yes.

Class of Service Options form

MiCollab Client desk phones and softphones can have different Classes of Service (COS) as long as the COS options below are properly set.

Configure the following fields and options on the Class of Service Options form:

• Group Presence Control: Set to Yes

• Group Presence Third Party Control: Set to Yes

• HCI/CTI Call Control Allowed: Set to Yes

• HCI/CTI Monitor Allowed: Set to Yes

• Display Caller ID on multicall/keylines: Set to Yes

• Voice Mail Softkey Allowed: Set to No

1. If set to Yes, users will not be able to hang up from their voice mailbox when using MiCollab Client.

Installation and Configuration

Personal Ring Group Assignment form

MiCollab Client users can use devices configured in the user's Personal Ring Group (PRG) for the

OfficeLink and Multi-Device User Group (MDUG) features. PRGs are an association of two or more devices for a single user under a common Directory Number (DN).

Notes:

•

Multi-Device User Groups are supported for MiVoice Business 5.0 and later ONLY.

•

For multiple devices support also see Synchronization Rules (under Synchronization Tab) on

Admin portal online help.

•

Mitel recommends using Multi-Device User Group for Softphone deployments.

•

Personal Ring Group (PRG) prime device must be an IP device and can not be a DNIC device.

Use the Personal Ring Group Assignment form to configure PRG devices for MiCollab Client users.

You will need to define a DN to be used as the prime member of the PRG using the Multiline IP Set

Configuration form.

SIP Softphone settings

MiVoice Business specific settings: To ensure proper functionality, there are two critical changes

that MUST be made on MiVoice Business when configuring a MiCollab Client SIP Softphone:

First, you must select a Device Type of MiCollab Client Endpoint.

Second, you must add at least one additional line. This is accomplished by adding a key with a

Line Type of Multicall, a Button Dir. Number matching the number of the device, and Ring Type of Ring.

MiVoice Office 250 PBX

All configuration changes for MiVoice Office 250 are completed using the Mitel MiVoice Office 250

DB Programming interface. The information in this section provides guidelines for MiCollab Client

-specific configuration only.

The following MiVoice Office 250 DB Programming folders include MiCollab Client-specific fields and options:

•

“Software license” on page 87

•

“System – devices and feature codes – Assistants” on page 87

•

“System – devices and feature codes – Phones” on page 87

•

“System – Sockets” on page 88

•

“Users” on page 88

Note the following for MiVoice Office 250 PBXs:

• The MiVoice Office 250 system must be running system software v5.0 or later and the system must be programmed correctly to support full remote click to call OfficeLink functionality (see

Table 12 on page 61 ).

• The MBG must be used when using remote SIP softphones connected to MiVoice Office 250.

MiCollab Client Administrator Guide

“License and PBX changes” on page 172 ).

• For sites that intend to use the PBX node synchronization method for creating accounts in

MiCollab Client, the MiCollab Client Service retrieves user and/or phone extension information configured in DB Programming to create accounts via the OAI stream for the PBX node synchronization type.

It is important that the information in the Users and/or Phones

folders in DB Programming is configured correctly to avoid the creation of unwanted accounts on the MiCollab Client Service if using PBX synchronization. PBX synchronization looks to the Users folder first and then the

Phones folder to create accounts during the initial synchronization.

• Before you run a PBX Node Synchronization from the Synchronization tab, it is recommended that you set the Default feature profile field to the Default Feature Profile. The Default Feature

Profile does not apply any features and licenses, so the system will not run out of licenses if there are more phones/accounts than available licenses. Instead, assign phones/accounts with the required licensed features from the MiCollab Client Service Features tab after performing the synchronization.

If the Synchronize Dynamic Extension only option in the Synchronization tab is enabled, only the extensions listed under Users will be synchronized. This option limits the number of accounts created.

• For sites synchronizing multiple MiVoice Office 250 PBX nodes, all nodes must be entered under

PBX Nodes. If using a CT Gateway, all MiVoice Office 250 nodes and the CT Gateway are entered under PBX Nodes. See the MiCollab Client Service Online Help for additional details.

Note:

The CT Gateway must be programmed to monitor all nodes programmed under PBX Nodes.

Adhere to the following guidelines when using a CT Gateway to synchronize multiple MiVoice

Office 250 nodes:

• When using a CT Gateway to communicate with multiple MiVoice Office 250 nodes, each node's session manager must have a DB programming account with the same password that matches the password set at the single PBX node representing the cluster on the

MiCollab Client Service.

• The CT Gateway must be running software version 4.4.01 or higher.

• All nodes configured on the CT Gateway must be communicating (up and working) so that the PBX synchronizer will synchronize all of the accounts. If one or more of the MiVoice

Office 250 nodes are not communicating with the CT Gateway, the node will not be synchronized as indicated by the message that is generated under the PBX Nodes tab.

• The PBX Node for CT Gateway must have a Voice Mail system pilot number programmed.

You must choose a Voice Mail application number from one of the MiVoice Office 250 nodes.

This will not impact phone/account voice mail set for each PBX.

• All nodes connected to the CT Gateway must be using OAI protocol version 10.0 or later

(MiVoice Office 250 v3.2). Node connections to the CT Gateway that are not running protocol

1. Prior to MiVoice Office 250 v4.0, this folder in DB Programming was named Endpoints.

Installation and Configuration

version 10.0 or later must be removed from the CT Gateway, or the nodes must be upgraded to v3.2.

• It is recommended that all duplicate extensions between nodes be removed before installing the CT Gateway. If this is not done, one of the accounts with the duplicate extension information will be deleted during the synchronization.

See Mitel Knowledge Base article number 4376 for additional MiVoice Office 250 configuration information.

Note:

Only MiVoice Office 250-certified personnel can configure the MiVoice Office 250 PBX.

Software license

The Software License folder in DB Programming displays the licenses currently uploaded to the system. The features common to all licenses are displayed in this folder along with the value for each feature according to the current software license. This folder is read-only.

The following MiVoice Office 250 system software licenses must be enabled to provide full integration with MiCollab Client:

• Dynamic Extension Express: Dynamic Extension Express provides Ring Group options for

MiCollab Client users in the MiCollab Desktop Client. Ring Groups provide call routing options for user’s Dynamic Statuses.

• System OAI 3rd Party Call Control: Provides call control capabilities from the PBX to MiCollab

Client so that users connected to the PBX can access system call features. System OAI 3rd

Party Call Control is required to support the Dynamic Extension Express PBX feature.

• System OAI Events: Allows MiCollab Client to monitor the devices on the PBX to provide advanced presence. System OAI Events are required to support the Dynamic Extension Express

PBX feature.

System – devices and feature codes – Assistants

For MiVoice Office 250 v5.0 and later systems, configure the OfficeLink Assistant to provide full

OfficeLink functionality for MiCollab Client users.

Adding an OfficeLink Assistant allows MiCollab Client users to place OfficeLink calls from any of their ring group devices (including Mobile). If the OfficeLink Assistant is not present (or if using software older than MiVoice Office 250 v5.0), then MiCollab Client users can only place OfficeLink calls from their desk phone and MiCollab Client softphone.

See page 60

for more information about the OfficeLink feature.

System – devices and feature codes – Phones

The MiCollab Client Service retrieves information programmed in the Users and/or Phones folders to create MiCollab Client accounts.

MiCollab Client Administrator Guide

If the Phones information is configured for the MiVoice Office 250, but the Users information is not, the MiCollab Client PBX node synchronizer retrieves the following information from the Phones folder in DB Programming to create MiCollab Client accounts:

• System – Devices and Feature Codes – Phones – Extension: The value configured in the

Extension field becomes the desk phone extension for the MiCollab Client account after synchronization.

• System – Devices and Feature Codes – Phones – Description: The value configured in the

Description field becomes the account name for the MiCollab Client account after synchronization. Note the following for the Description field:

• Configure the user’s name in Last name, First Name format for the Description field. This is the format used by the PBX node synchronizer for the account name in MiCollab Client.

• The Tilde character (~) before the Description and a blank Description field excludes the account from the synchronization.

Note:

If you create both a desk phone and a MiCollab Client Softphone in DB Programming for a single user, two separate accounts are created in MiCollab Client for the extensions during the PBX node synchronization.

System – IP-related information – Call Configuration

(Softphones Only)

Mitel recommends that you configure audio settings specific to the MiCollab Client Softphone to ensure good audio quality.

Under System – IP-Related Information – Call Configuration, configure the Audio Frames/IP Packet with a value of 2.

System – Sockets

To support MiCollab Client, select System – Sockets, and set the System OAI Level 2 option to Yes.

Users

The MiCollab Client Service retrieves information programmed in the Users and/or Phones folders

to create MiCollab Client accounts. See “About Account Synchronization” on page 53 .

If the Users information is configured for the MiVoice Office 250, but the Phones information is not, the MiCollab Client PBX node synchronizer retrieves the following information from the Users folder in DB Programming to create MiCollab Client accounts:

• Users: Configure the First Name and Last Name fields. These fields provide the value for the account name on the MiCollab Client Service.

Installation and Configuration

Note the following:

• To exclude a MiCollab Client account from being created during synchronization, insert the

Tilde character (~) before the First Name or Last Name.

Note:

If there is a phone programmed with the same extension under the Phones folder and the

Description does not include a tilde, the phone will be included in the synchronization.

• If the First Name and Last Name fields are blank in DB Programming, MiCollab Client will create an account with no name.

Note:

If there is a phone programmed with the same extension under the Phones folder and the

Phones Extension field matches the User Main Extension field, then the name from the Phones

Description field is used for the synchronization.

• If both Phones and Users is programmed in DB Programming, if the Phones Extension fields and Users Main Extension field match, then only one account is created.

• Users – <user>: Configure the following for each user:

• The value configured for the Main Extension field becomes the desk phone or softphone extension for the MiCollab Client account after synchronization. MiCollab Client softphones are allowed as the Main Extension.

• The Yes value configured for the Enable Dynamic Extension Express field instructs the

PBX node synchronizer to use the programmed Associated Destinations fields when configuring Ring Group devices. In addition, this value instructs AD/LDAP synchronizers to synchronize Dynamic Express Extension information from the PBX.

• Associated Destinations: Configure the values for the Associated Destinations sub folder.

MiCollab Client users can use devices configured as the user's Associated Destinations for the

OfficeLink feature (see

“OfficeLink functionality” on page 60 ). These values populate the My

Ring Group devices in the MiCollab Client account after synchronization:

• Desk, Desk 2

• Voice Mail

• Home, Home 2

• Home IP, Home IP 2

• Mobile, Mobile 2

• Softphone, Softphone 2

Note:

Associated Destinations must be set to Active to be included in the PBX node synchronization.

MiVoice MX-One PBX

All configuration changes for MiVoice MX-One are completed using the Manager Provisioning and

Manager Telephony System interface.

MiCollab Client Administrator Guide

Configure integrated applications

To install and configure the Mitel applications you want to integrate with your MiCollab Client installation, see the documentation that was provided with the application. Documentation is also available on the Mitel eDocs Web site (http://edocs.mitel.com).

Mitel integrated applications/products include:

• MiCollab Unified Messaging (UM) v4.0 or later

• MiCollab Audio, Web and Video Conferencing (formerly known as Audio and Web Conferencing)

4.0 or later

• MiVoice Border Gateway v7.1 or later

• MiContact Center v7.1 or later

This section describes basic MiCollab Client configuration requirements for Mitel integrated applications. You may also need to configure integrated third-party application servers and components for use with MiCollab Client. For configuration guidelines for third-party products, see the product documentation.

MiCollab UM configuration

MiCollab Client includes a Visual Voice Mail view in the MiCollab Desktop Client that provides access to MiCollab UM voice mail and FAX messages. Other Mitel and third-party voice mail systems are not supported by MiCollab Client.

To provide visual voice mail features, the MiCollab UM server must be configured properly as described in the following sections:

•

Visual Voice Mail for Peered MiCollab Client Services , below

•

MiCollab configuration options , below

•

“FCOS options” on page 91

•

“Port utilization” on page 91

Visual Voice Mail for Peered

MiCollab Client

Services

When MiCollab Client Services are peered, the MiCollab UM voice mail servers must be networked in the peered configuration for the voice mail forwarding and transfer to voice mail features to function.

MiCollab Client does not support multiple MiCollab UM voice mail systems for peered MiCollab

Client Services.

If MiCollab Client Services are peered and each server is configured with a different voice mail system, the following MiCollab Client voice mail features will not function between the servers:

• A MiCollab Desktop Client user on MiCollab Client Service A cannot forward a voice mail message to a peered contact on MiCollab Client Service B.

• A MiCollab Desktop Client console user on MiCollab Client Service A cannot use the Transfer to Voice Mail feature to transfer a call to a voice mailbox on MiCollab Client Service B.

Installation and Configuration

MiCollab configuration options

The Dialer (Pager) and a Pager Line Group must be configured for MiCollab under System

Configuration to enable the “Request playback call” function in the MiCollab Desktop Client Visual

Voice Mail view. It is not necessary to enable the dialer or pager on each mailbox under Message

Waiting.

Note:

If your MiCollab UM application is running on a MiCollab server, Mitel recommends upgrading to

MiCollab software version R2.0.1.106 or later, which includes several MiCollab UM Dialer updates.

FCOS options

The following MiCollab UM feature (FCOS) options are required for MiCollab Desktop Client to control voice mail calls within the application:

• FCOS 289 Enable UM-SMTP

• FCOS 290 Enable UM-Web

• FCOS 295 Enable UM Pro

The following features are required for Caller ID to appear in the MiCollab Desktop Client:

• FCOS 262 Store Caller Line ID as Phone Number

• FCOS 263 Store Caller Line ID as Phone or Mailbox Number

• FCOS 264 Play outside caller user interface (With FCOS bit 280)

• FCOS 280 Enable CLI Outside Caller interface (with FCOS bit 264)

Port utilization

From the Visual Voice Mail view, users can listen to voice mail messages from the MiCollab Desktop

Client as follows:

• Direct the voice mail system to place a call to their desk phones and play the message using the “Request playback call” function.

• Play the message on their computer using the default media player.

When users direct the voice mail system to place a call to their desk phone, MiCollab Client consumes outgoing MiCollab UM ports, for the duration of the voice mail message. When users play voice mail messages using their media player, no outgoing ports are consumed.

Be sure you have configured sufficient outgoing MiCollab UM ports for MiCollab Client. If users regularly receive a busy signal when directing the voice mail system to call their desk phone and

MiCollab Client Administrator Guide

play voice mail messages, MiCollab UM may not have sufficient outgoing ports configured. See the

MiCollab UM Port Utilization Report to capture port utilization details.

Note:

Like the MiCollab Client Service, the MiCollab UM server needs to have a publicly-resolvable hostname. This hostname is used by the MiCollab Desktop Client and the Web Portal when users listen to voice mail messages using the media player installed on their computer. If users cannot access the MiCollab UM server from their computers, voice mail message playback is limited to the Request playback call option from the MiCollab Desktop Client.

Other Voice Mail systems

The MiVoice Business and MiVoice Office 250 PBXs support embedded legacy and third-party voice mail systems. If the PBX is connected to a voice mail system other than MiCollab UM, the Visual

Voice Mail feature will not function. Because the PBX provides call routing to voice mail, only the

Call Voice Mail and Send to Voice Mail features will function in MiCollab Client when the PBX is connected to non-MiCollab voice mail systems.

When the PBX is connected to a non-MiCollab UM voice mail system, note the following configuration information:

• The PBX node must be configured on the PBX Node tab and it must be synchronized with

MiCollab Client.

• Some legacy voice mail systems have a different pilot number for the message retrieval application versus the voice mail application. To ensure that MiCollab Client users reach the Message

Retrieval application instead of the Voice Mail application when they use the Call Voice Mail function, the MiCollab Client Administrator can configure the Voice Mail Number field on the

PBX Details page with the Message Retrieval application extension.

• If MiCollab Client Desktop Clients are open when the administrator makes changes to the PBX configuration in the MiCollab Client Service Administrator interface, they must be closed and reopened for configuration changes to take effect.

After the voice mail systems are configured on the MiCollab Client Service, the Call Voice Mail and

Send to Voice Mail features are functional.

MiCollab Audio, Web and Video Conferencing configuration

MiCollab Audio, Web and Video Conferencing provides collaboration features and video calls for

MiCollab Desktop Client users.

To provide access to audio conferencing, Web conferencing, collaboration features and video calls, verify the following for MiCollab Audio, Web and Video Conferencing:

• The MiCollab Audio, Web and Video Conferencing server has sufficient ports and licenses configured for all users – including MiCollab Client users.

• If you know the URL for the MiCollab Audio, Web and Video Conferencing server, you can synchronize the MiCollab Client Service with the MiCollab Audio, Web and Video Conferencing

Server during system provisioning (see

“Provision MiCollab Client” on page 107 ).

Installation and Configuration

MiVoice Border Gateway and Remote Proxy Services configuration

Note:

Only MiVoice Border Gateway/Remote Proxy-certified personnel can configure the MiVoice Border

Gateway.

If the customer site is using an MiVoice Business PBX and has remote users, you must configure the MiVoice Border Gateway and Remote Proxy Services for use with MiCollab Client as described in this section. Additional configuration for the MiVoice Border Gateway is required after the MiCollab

Desktop Clients are installed.

MiVoice Border Gateway provides a secure communications path from remote MiCollab Desktop

Client, Mobile Clients as well as softphones and IP desk phones running on the MiVoice Business

PBX to the MiCollab Client Service. Remote Proxy Services provide a secure communications path for remote MiCollab Web Portal users.

Notes:

•

If the customer is using MiVoice Border Gateway in a perimeter network (DMZ), the firewall that the MiVoice Border Gateway is connected to may have Session Initiation Protocol (SIP) application layer gateway (ALG) functionality turned ON, which may interfere with SIP messaging on MiCollab Client. Mitel recommends that you disable the firewall's SIP ALG for this type of configuration.

•

Starting in MiCollab Client v5.1, when teleworker mode is enabled in the MiCollab Desktop

Clients and mobile clients, the SIP softphone and Minet softphone route the signaling and media traffic through the MiVoice Border Gateway even when the clients are used in the corporate LAN.

To configure MiVoice Border Gateway for use with

MiCollab Client

:

Note:

See the appropriate version of MiVoice Border Gateway documentation on the Mitel eDocs Web site (http://edocs.mitel.com

) for updated information and images.

Open a Web browser and navigate to the MSL Server Manager URL (for example,

https://<MSL_server_FQDN>/server-manager

) where the MiVoice Border Gateway/Remote

Proxy Services are installed. The server manager log in page appears.

Under Applications, click MiVoice Border Gateway.

Click the Configuration tab. Click the ICPs tab.

On the ICP tab, click Add ICP to add the MiVoice Business PBX (3300 ICP).

Program the ICP settings as described in the online Help.

Click Save. The Successfully created ICP message appears.

Click the Applications tab. The Manage Connectors data is displayed.

Select MiCollab Client on the Connectors page, and then click Edit.

MiCollab Client Administrator Guide

Modify the MiCollab Client connector as follows:

• Ensure the MiCollab Client connector is enabled.

• Type the IP address or hostname for the MiCollab Client Service in the following fields:

• MiCollab Client Service hostname or IP address

• Collaboration server hostname or IP address

• Type the IP address or hostname for the MiCollab UM voice mail server in the MiCollab

voicemail hostname or IP address field.

• Click Save.

To configure Remote Proxy Services for use with MiCollab Client :

The external DNS entry for the MiCollab Client Service needs to resolve to the Remote Proxy

Services server so that users outside of the internal LAN can use the Remote Proxy Services to access the MiCollab Client Service.

Open a Web browser and navigate to the MSL Server Manager URL (for example,

https://<MSL_server_FQDN>/server-manager

) where the MiVoice Border Gateway/Remote

Proxy Services are installed. The server manager log in page appears.

Under Applications, click Remote Proxy Services.

Click Add new proxied domain, and create a new proxied domain for the MiCollab Client

Service.

MiCollab Client and Ignite integration

Note:

MiCollab Client must be Version 6.0 SP3 or later.

Read the following notes and recommendations before installing and running MiCollab Client and

Ignite integration:

• The deployment must be licensed for MiCollab Client deskphone and softphone.

• Basic MiCollab Client does not support full MiCollab and Ignite functionality.

• YourSite Explorer and MiCollab Client Agents’ first and last names must be the same. If there are two agents with identical first and last names, ensure they have unique e-mail addresses in both YourSite Explorer and MiCollab Client.

• In a Windows 8 environment, ensure the MiCollab Client process runs as administrator by selecting Run this program as an administrator in the MiCollab Client properties settings.

• Under Feature Profile Details, select the Desktop client SDK and Presence checkboxes.

• Users need to disable Show Call Popup Window in MiCollab Desktop Client to prevent duplicate toasters from displaying on the desktop.

Ignite users can enable a more advanced screen pop. See MiContact Center Solutions

User Guide for more information.

If Ignite is shut down users can select the Show Call Popup Window checkbox. See

Installation and Configuration

MiCollab Desktop Client help for more information.

Enabling Hot Desking for Ignite Agents

MiCollab Desktop Client users can Hot Desk into their Minet Softphone.

Note:

Supported only with MiVoice Business implementation.

Configure the soft phone. The softphone Directory Name must match the Hot Desk Agent

Directory Name.

Select 5020 IP as the Device Type.

Synchronize the PBX Nodes on MiCollab Client Service. See the MiCollab Client Administrator online help.

The new account name matches the Directory Name defined in MiVoice Business.The primary number for the desk phone corresponds to the DN of the agent (in this example, 40108). The soft phone device corresponds to the DN of the soft phone (in this example, 30108).

Configure the account. Set the Published field for the Softphone to No. Leave the default ACD settings.

The Ignite agent can now follow the Hot Desking procedure as described in the MiCollab Desktop

Client help.

MiCollab Client Administrator Guide

Install and configure MSL and MiCollab Client Service

MiCollab Client includes two options for the MiCollab Client Service component: MiCollab Client

Software and MiCollab Client Virtual Appliance (see page 72 for details).

If MiCollab Client is being installed as application on MiCollab, see the MiCollab Installation and

Maintenance Guide: http://edocs.mitel.com/default.htm#MiCollab_anchor

High-level installation and configuration steps are provided for each deployment option, below:

• MiCollab Client Software: High-level installation and configuration steps include:

•

“Install the MSL operating system” on page 97.

•

“Configure MSL” on page 97.

•

“Install the MiCollab Client Service blade” on page 99.

•

“Verify MiCollab Client Service licensing” on page 100.

• MiCollab Client Virtual Appliance: High-level installation and configuration steps include:

•

“Install the MiCollab Client Virtual Appliance” on page 100.

•

“Configure MSL” on page 97.

•

“Verify MiCollab Client Service licensing” on page 100.

Note:

This document assumes that the MiCollab Client administrator and the MSL administrator are the same person.

Software installation options

The MiCollab Client Service software includes both the server and client software for MiCollab Client.

Before beginning a software installation for MiCollab Client, review the release notes and the

Engineering Guidelines for a comprehensive list of requirements.

There are two methods you can use to install MiCollab Client software:

• Download and install the software blade directly from the AMC using the Server Manager interface.

• Download the ISO software image from Mitel Online, create a software CD, and install from CD.

To download and install software directly from the AMC:

Open a Web browser and navigate to the MSL server manager URL where the MiCollab Client

Service is installed (for example,

https://<MSL_server_FQDN>/server-manager

). The server manager log in page appears.

In the left navigation pane under ServiceLink, click Blades. The available list of blades is displayed.

Install the software blade as detailed in the Service Manager online help.

Installation and Configuration

To download an ISO software image, build a CD, and install from CD:

Log on to Mitel Online.

Select Support, and then click Software Downloads.

Click MiCollab Client – MiCollab Client Software Download.

Click the appropriate links to download the software.

Agree to the download disclaimer.

Save the file to a location on your maintenance computer.

Insert a CD into the CD/DVD ROM drive of your maintenance computer.

Navigate to the stored MiCollab Client Service software ISO image and burn the image to CD.

Insert the CD in the hardware platform’s CD ROM drive and install the software.

Install the MSL operating system

MiCollab Client runs on MSL as a stand-alone application. This section describes the high-level MSL installation steps.

Note:

The procedure in this section applies to the MiCollab Client Software server deployment type. It does not apply to MiCollab Client Virtual Appliance.

For detailed installation instructions for MSL, see the MSL Installation and Administration Manual on the Mitel eDocs Web site (http://edocs.mitel.com).

To install the MSL Server:

Install the hardware platform as described in the MSL Installation and Administration Manual.

Install the MSL v10.0 operating system as described in the MSL Installation and Administration

Manual.

Configure MSL

This section describes the high-level MSL configuration steps.

Note:

The procedure in this section applies to both server deployment types:

• MiCollab Client Software

• MiCollab Client Virtual Appliance

For detailed MSL configuration instructions, see the MSL Installation and Administration Manual on the Mitel eDocs Web site (http://edocs.mitel.com).

MiCollab Client Administrator Guide

To configure MSL:

Configure the MSL server settings. The following table lists the information you will need to enter during the MSL configuration process.

MSL Setting

Administrator Password

Domain Name

System Name

Local Network Adapters

Local Networking Parameters

WAN Adapters

External Interface Connection

Gateway IP Address

DNS Server IP Address

IPv6 Configuration

Description

For password strength, choose a password that contains a mix of uppercase and lowercase letters, numbers, and punctuation characters.

Names must start with a letter; can contain letters, numbers, and hyphens.

MSL automatically detects your system's Ethernet adapters and displays them (eth0, eth1) so you can configure a “Local” adapter

(for LAN mode) or a “Local” AND a “WAN” adapter (for Network

Edge mode). When configuring

MiCollab Client

Service, only the first local adapter should be configured (for LAN mode).

The local IP address and subnet mask for the server.

This setting is not applicable for

MiCollab Client

Service configuration.

This setting is not applicable for

MiCollab Client

Service configuration.

The IP address that

MiCollab Client

Service will use to access the network.

The IP address of your corporate DNS server.

Note the following:

• If you specify a Corporate DNS server, you must also configure the server's domains to Use Corporate DNS Servers under

Configuration – Domains in Server Manager.

• If DNS is supplied by your ISP, leave this setting blank.

N/A. IPv6 is not currently supported by

MiCollab Client

Service.

Using the Application Record ID you received from the AMC, register the server with the AMC and download licensing information.

https://<MSL_server_FQDN>/server-manager

Note: MSL provides two methods of completing offline synchronizations with the AMC for servers with no direct Internet connection. See the Mitel Standard Linux Installation and

Administration Guide for instructions.

Log into the MSL server manager interface. The Welcome to the Server Manager page appears.

In the left navigation pane under Configuration, click E-mail Settings. The E-mail configu-

ration page appears.

Click Change for the Forwarding address for administrative e-mail field.

Installation and Configuration

Enter your e-mail address in the box and then click Save.

Note:

You must configure this field so that e-mail messages generated by the MiCollab Desktop

Client Problem Reporting Tool (see “Problem reporting tool” on page 175 ) are routed to your

e-mail address.

Install the MiCollab Client Service blade

The MiCollab Client Service blade contains the server and client software for MiCollab Client. If

required, install the MiCollab Client Service blade.

Note:

The procedure in this section applies to the MiCollab Client Software server deployment type. It does not apply to MiCollab Client Virtual Appliance.

To install the MiCollab Client Service software blade:

Open a Web browser and navigate to the MSL server manager URL where the MiCollab Client

Service is installed (for example,

https://<MSL_server_FQDN>/server-manager

). The server manager log in page appears.

If you are installing the blade from CD, insert the CD in your CD ROM drive.

If you are installing the blade directly from the AMC, proceed to the next step.

In the left navigation pane under ServiceLink, click Blades. The available list of blades is displayed.

If you are downloading the software directly from the AMC, click Update List to ensure an up-to-date listing.

Skip this step if you are installing from CD.

Note:

If the AMC sync process is disabled, the blades list will not be refreshed. The listing will show only installed blades, blades from CD, and entries from the last sync.

Click the Install link beside the blade you want to install. The licenses page appears displaying the licensing information for the MiCollab Client Service software blade.

Review all of the licensing information.

Scroll to the bottom of the page and click Accept All Licenses. The installation process for the

MiCollab Client Service blade begins. The installation screen provides installation Progress

Overview and Progress Details information.

MiCollab Client Administrator Guide

A successful installation message appears below the Process Overview when the blade is completely installed.

Click Clear this report.

After the MiCollab Client Service blade installation is complete, the MiCollab Client Service automatically starts.

Verify MiCollab Client Service licensing

Follow the steps below to verify that the required licensing information is available for the MiCollab

Client Service.

Note:

The procedure in this section applies to both server deployment types:

•

MiCollab Client Software

•

MiCollab Client Virtual Appliance

To verify

MiCollab Client

Service licensing:

Open a Web browser and navigate to the MSL server manager URL (for example,

https://<MSL_server_FQDN>/server-manager

) where the MiCollab Client Service is installed. The server manager log in page appears.

Under Service Link, click Status. The current ServiceLink Status information is displayed.

Click Sync in the bottom right hand corner to download the MiCollab Client license information from the AMC to the MiCollab Client Service. The sync completed successfully message appears.

Install the MiCollab Client Virtual Appliance

The MiCollab Client virtual appliance allows you to install MSL and the MiCollab Client Service in an existing virtual environment.

This section describes the installation and configuration steps to deploy the MiCollab Client virtual

appliance. For other MiCollab Client deployments, see the options listed on page 96.

For more detailed information on virtualization, see the Virtual Appliance Deployment Solutions

Guide available on http://edocs.mitel.com.

Note:

The procedure in this section applies to the MiCollab Client virtual appliance (vMiCollab Client) deployment type. It does not apply to MiCollab Client Software.

100

Installation and Configuration

The VMware vSphere Client must be installed on the local machine before deploying the MiCollab

Client virtual appliance.

To install the

MiCollab Client

virtual appliance:

Download the virtual appliance file (.ova) from Mitel OnLine and save it on your local machine.

Start the vSphere Client, and then select File – Deploy OVF Template….

Select Deploy from file and then browse to the location on your machine where you saved the file.

Click Next. The OVF Template Details page appears.

Click Next. The End User License Agreement page appears.

Click Accept, and then click Next. The Name and Location page appears.

Type a name for virtual server, and then click Next. Deployment settings for the virtual appliance are shown.

Confirm the settings, and then click Finish to deploy the file. A dialog box shows the progress of the files being deployed.

When the deployment completes successfully click Close to continue.

10. In the vSphere client window, expand the VMware host view to show the newly created virtual machine.

11. Click the Console tab. Click the green arrow to power on the virtual machine.

12. After the virtual machine has booted, the Console Tab shows the MSL installation window.

To complete the configuration for the MiCollab Client virtual appliance:

•

“Configure MSL” on page 97.

•

“Verify MiCollab Client Service licensing” on page 100.

Install and configure MiCollab Client softphone for VMware Horizon View

This section describes how to install and configure MiCollab Client for VMware Horizon View. For more information, see the VMWare Horizon View Solutions Guide.

Requirements

MiCollab Client for VMware Horizon View requires the following:

• The MiCollab Client Plugin - the installer for this is called UnifiedCommunicatorAdvancedVMwareViewplugin.msi and can be found on Mitel Online in the 6.0 Software Downloads folder in the MiCollab Client folder.

• View 5.0, View 5.1, View 5.2 and vSphere 5.0

Note:

Versions prior to 5.0 are NOT supported.

101

MiCollab Client Administrator Guide

• Windows 7 virtual desktop

Note:

MiCollab Client for VMware Horizon View is NOT supported on the following products:

•

Windows Vista or XP, Apple, Android or Linux.

It is assumed that the required VMware and Windows components are set up. These can be obtained through VMware and www.Microsoft.com respectively.

Installation

Use the following procedure to install MiCollab Client with VMware Horizon View:

Install and configure VMware Horizon View and the virtual desktops following the instructions provided by VMware.

It is strongly recommended that the protocol is set to PCoIP and that other protocols are

disallowed. Failure to do so will result in inconsistent or non-existence audio for users. Perform the following steps:

In VMware View administration, go to Inventory>Pools.

In Settings, go to the Pool Settings tab.

Under Remote Display Protocol, choose PCoIP for Default Display Protocol. Choose No for

Allow Users to Change Protocol. Click OK to save your changes.

Install and configure the MiCollab Client 6.0 server.

Install MiCollab Client on each virtual desktop (in View backend).

Install the MiCollab Client (which is downloaded from the MiCollab Client Service) using the instructions found in the Welcome e-mail.

NOTE: Virtual clients look exactly like regular desktops, but they exist in the View backend.

Install the VMware View Client on each physical desktop (the physical Thin Client or Thick

Client/repurposed PC).

Point your browser to the address of the View Connection Server.

Ensure that you select the correct version (32-bit or 64-bit) for your physical desktop.

NOTE: Local mode is not required.

Double click the installer.exe file after it downloads and follow the instructions provided.

Thin Client devices normally come with the View client already installed. If this is not the case for your Thin Client, follow the vendor-specific instructions provided with your Thin Client.

Install the MiCollab Client Plugin on each physical desktop. The Plugin is the media driver software that runs on the physical device. This Plugin ensures that voice streams locally through the physical device.

For the PC/Thick Client - doubleclick the .msi file. A brief progress dialog appears. You do not have to do anything but monitor the progress. Click Done when the installation has completed.

For the Thin Client, perform the following steps:

102

Installation and Configuration

Log in as Administrator (see the Thin Client documentation to determine how to log in as Administrator. The default password is vendor-specific.

Unlock the device. See your vendor documentation to determine the location of the lock application. The device will reboot when you unlock it.

Download and install the correct version of the .msi file.

Relock the device by performing a reverse of the procedure in substep 2). The device

will reboot when you lock it.

Notes:

•

Automated methods for mass deployment of the Plugin to Thin Client is possible using vendor-specific tools (for example, Wyse Device Manager or HP Device Manager).

Procedures for using these tools to perform mass deployment are being developed.

•

Ensure the Thin Client is set to operate in LAN mode (not Wireless mode).

Configure user options MiCollab Client for VMware Horizon View

Once the component parts (MiCollab Client Service, MiCollab Client, VMware Horizon View, and the MiCollab Client Plugin) have been installed, the following user configuration steps must be completed for MiCollab Client VMware Horizon View to function properly.

Teleworker Configuration

In MiCollab Client for VMware Horizon View, the teleworker options enable you to properly configure the MiCollab Client software to interact with the VMware Horizon View virtual desktops.

This section outlines how to configure the Teleworker options specifically for use with MiCollab Client for VMware Horizon View. These steps do NOT configure normal Teleworker mode. For information on configuring Teleworker mode in the traditional setup, see MiCollab Desktop Client online help,

Teleworker topic.

When MiCollab Client starts it will always try to connect directly to the MiCollab Client Service. If

MiCollab Client is unable to connect directly to the server, it will start in Teleworker mode if you have a valid Teleworker certificate or in VMware Horizon View mode if you have the .msi file installed. If

MiCollab Client is unable to determine if you have a valid certificate OR if it does not detect a valid

VMware Horizon View installation, it will start in Offline mode.

To configure the Teleworker options in MiCollab Client for VMware Horizon View, go to the

Configuration Screen in the MiCollab Desktop Client and set the following options:

Directory Number: Type your remote Softphone or IP desk phone extension in the box. This must be a number ranging from 1 to 99999999.

Teleworker Gateway IP: Type the IP address of the MiVoice Border Gateway. The IP address should be in the form of xxx.xxx.xxx.xxx.

If there are any leading zeros in the IP address, do not enter those (for example, if the IP address is 074.xxx.xxx.yyy, enter 74.xxx.xxx.yyy.

103

MiCollab Client Administrator Guide

For MiCollab Client VMware Horizon View purposes only, you do not need to enable Teleworker mode, nor configure any of the other Teleworker options. You also do not need to have a valid

Teleworker certificate. All these options are greyed out.

Device Configuration

After you have configured MiCollab Client for VMware Horizon View, you must configure the devices

(headsets) that work when your client is operating in VMware Horizon View mode. Once the MiCollab

Client Plugin has been installed, you must configure the MiCollab Client and your virtual desktop to work properly with the endpoint device (Thin or Thick Client).

Use the Softphone Settings in the Configuration menu on the MiCollab Client to configure these devices.

Ensure that you have chosen either Bluetooth or USB audio device as your default audio device for both Playback and Recording. ONLY these options work correctly with MiCollab Client for VMware

Horizon View:

On the physical device, go to Start>Control Panel>Sound.

Under both the Playback and Recording tabs, ensure that the default device is the Bluetooth or

USB audio device. Click on the proper device. Click on Set Default and choose Default. Under

Properties, ensure Use this device is chosen. Confirm all choices.

Note:

Do not use USB redirection for your audio devices (on the View Client, the option is under

Connect USB Device at the top of the screen). Using USB redirection causes audio to flow through the virtual desktop, and results in poor or nonexistent audio.

Headsets

MiCollab Client VMware Horizon View supports several headsets for audio.

Softphone settings

Configuring the softphone settings for MiCollab Client for VMware Horizon View on the MiCollab

Desktop Client is very similar to configuring devices for the thick client version. However, there are now additional options specifically for MiCollab Client VMware Horizon View.

In the MiCollab Client Configuration menu, Softphone Settings, you can choose either Local (to your machine) or View (for MiCollab Client VMware Horizon View) options for both the Microphone and the Speaker settings. If you choose local, but no devices are available on your machine, MiCollab

Client switches automatically to the VMware Horizon View options.

Expected behavior

The MiCollab Desktop Client operates in one of two modes, namely:

• Local softphone (meaning on the same machine at the MiCollab Desktop Client itself)

• View softphone (meaning as a plug-in to VMware Horizon View).

104

Installation and Configuration

In order to switch between softphones, MiCollab Client must deregister the current softphone to bring the new active softphone online. This switchover causes a delay - no more than five to ten seconds.

The UI does not directly indicate which mode of softphone is active.

105

MiCollab Client Administrator Guide

Access the MiCollab Client Service administration page

The MSL server manager interface provides access to the Mitel MiCollab Client Service

Administration page. From this page you can:

• access the MiCollab Client configuration interface to provision MiCollab Client (see

“Provision

MiCollab Client” on page 107

• view and refresh the server status, and start and stop the server (see

“Status” on page 146 ).

• generate diagnostics information (see

“Diagnostics” on page 147 ).

To access the

MiCollab Client

Service Administration page:

Open a Web browser and navigate to the MSL server manager URL (for example,

https://<MSL_server_FQDN>/server-manager

) where the MiCollab Client Service is installed. The server manager log in page appears.

Under Applications, click MiCollab Client Service. The Mitel MiCollab Client Service Administration page appears.

The page may show a status of

STARTING

while the server is being started. The status changes to

ACTIVE

when the server is operational.

106

Installation and Configuration

Provision MiCollab Client

Provision MiCollab Client as documented in the MiCollab Client Service Administrator interface online help. See the Provisioning MiCollab Client help topic, which includes the high-level provisioning procedure, with links to detailed instructions and field descriptions.

To access the MiCollab Client Service administrator interface and online help:

Open a Web browser and navigate to the MSL server manager URL (for example,

https://<MSL_server_FQDN>/server-manager

) where the MiCollab Client Service is installed. The server manager log in page appears.

In the left navigation pane under Applications, click MiCollab Client Service. The Mitel MiCollab

Client Service Administration page appears.

Click Configure Mitel MiCollab Client Service. The Enterprise tab appears.

Click the help icon to open the online help. The About MiCollab Client Service topic appears.

In the Help table of contents, click the Administrator Tasks link, and then click the Provisioning

MiCollab Client link. The Provisioning MiCollab Client topic appears, which includes the high-level steps you should follow to provision the system.

High-level provisioning steps include:

Create an enterprise.

Add Feature Profiles.

Add PBX nodes.

Add collaboration servers (optional).

Configure the enterprise fields and options.

Add user accounts using one of the following methods:

• Add user accounts automatically, by configuring a an Active Directory/Lightweight Directory Access Protocol (AD/LDAP) Corporate Directory Synchronizer, and then completing a manual synchronization.

Note:

See the following topics in the MiCollab Client Service Administrator online help for detailed information about AD/LDAP Corporate Directory Synchronizers:

•

Synchronization Tab

•

Adding and Editing AD/LDAP Synchronizers

• Add user accounts automatically, by configuring a Private Branch Exchange (PBX) Node

Corporate Directory Synchronizer, and then completing a manual synchronization.

107

MiCollab Client Administrator Guide

• Add user accounts manually. Accounts that you create manually are not affected if you later configure a Corporate Directory Synchronizer and complete an AD/LDAP or PBX node synchronization.

Configure Automatic Call Distribution (ACD) settings (optional).

Configure Peering with other MiCollab Client or external servers (optional).

Configure IM and presence Federation (optional). Configuration options include:

• Peering tab: Add an external IM server and perform an AD/LDAP synchronization with the server. After synchronization, the IM server contacts are imported to the MiCollab

Client Service database (visible from the Corporate Directory tab) and federation is automatically enabled.

• Federation tab: Configure federation from the Federation tab in the MiCollab Client

Service Administrator Interface.

Note:

Federation must be fully-configured on the IM server before you configure federation for the

MiCollab Client Service (see “Federation” on page 26 ).

Send the Welcome E-mail Message to MiCollab Client users (see

page 110 ).

108

Installation and Configuration

Install the MiCollab Desktop Client

The MiCollab Client installer ships as a Windows Installer package. You can use a file server on your network as a software distribution point for the MiCollab Client. When you complete the system configuration, send the Welcome E-mail to users, which includes a link to the software location on the server.

Software distribution point

A Software Distribution Point uses Active Directory Group Policy objects to deploy MiCollab Client using Active Directory Group Policy objects. This enables MiCollab Client to be run from a single location and appear to be installed on every user's desktop.

Installing MiCollab Client using a distribution point is done with an administrative install of the installer package to a network share. The share point must be accessible to all users who will install MiCollab

Client. The command for the administrative installation is:

%>msiexec /a UnifiedCommunicatorAdvanced.msi

The administrative installation wizard prompts you to enter a location for the administrative image.

Users can be instructed to install MiCollab Client from this folder via the network share. The users can run the installation wizard by clicking the file and entering the MiCollab Client Service FQDN when prompted.

Alternatively, a transform file (see

“Creating a transform” on page 115 ), or the Explorer shortcut that

includes the IP property in the command parameters, could be provided:

%>msiexec /i UnifiedCommunicatorAdvanced.msi UC_SERVER_HOSTNAME=”192.168.1.66”

In this example, UC_SERVER_HOSTNAME property is set to the IP address of the MiCollab Client

Service.

Suppressing the installation wizard dialogs can further customize the installation by using the /qn flag. More customization options can be found in the Windows Installer SDK documentation at http://msdn2.microsoft.com/en-us/library/aa367988.aspx

User installation permissions

Installing MiCollab Client requires administrator permissions on the user’s computer. In Windows

Vista/7, the user is prompted to provide User Account Control credentials (standard user) or confirmation (administrator) to install the client. Running the client does not require administrative privileges.

All data files that are modified (logs, config, contact database, recorded calls, etc.) when settings are updated (call forwarding profile, startup mode, etc.) are located in one of the following folders or subfolders:

• Vista/Windows 7:

C:\Users\<username>\AppData\Roaming\Mitel\UC

Client firewalls

A client computer that uses a firewall, such as Windows Firewall or a third-party firewall, must specify

MiCollab Client.exe and UCASoftphoneManager.exe as exceptions in the firewall's configuration settings. This allows UCA.exe and UCASoftphoneManager.exe to accept network traffic through the firewall. The MiCollab Client 6.0 client installer adds these exceptions automatically.

109

MiCollab Client Administrator Guide

Welcome E-mail message

After you configure the system, you can send the users a Welcome E-mail Message that provides users with the following information and links:

• The MiCollab Client Service Fully Qualified Domain Name (FQDN): Required when installing the MiCollab Desktop Client, MiCollab for Mobile for BlackBerry and MiVoice for Skype for

Business software.

• MiCollab Client Login ID and Password: Used to log in to the MiCollab Desktop Client, Web

Portal and MiVoice for Skype for Business.

• Softphone and Desk phone extensions.

• A link to the MiCollab Client URL: Provides access to the Web Portal.

• A link to the Quick Reference Guide: Provides installation instructions and a brief overview of the MiCollab Client product.

• A secure link to the MiCollab Desktop Client Software: Provides access to the MiCollab

Desktop Client software .msi file.

• A secure link to MiVoice for Skype for Business Software: Provides access to MiVoice for

Skype for Business software.

Note:

To configure a secure connection to the MiCollab Client Service from a mobile device, users are required to know the key store password on their device to accept the MiCollab Client Service

SSL certificate.

MiCollab Client Deployment E-mail message

If you deploy MiCollab for Mobile or MiCollab MAC Desktop Client, a separate deployment email will be sent to users. The deployment email provides users with links to install and deploy clients.

See MiCollab Client Deployment help for more information.

110

Installation and Configuration

Microsoft .NET framework

The MiCollab Desktop Client requires the installation of the Microsoft .NET Framework prior to installing the MiCollab Desktop Client. When the user attempts to install the MiCollab Desktop Client, if the NET framework is not detected, he or she will be prompted to download and install it.

After the user installs the .NET framework, he or she will need to restart the MiCollab Desktop Client installation. You can download the Microsoft .NET Framework v4.5

from the Microsoft Web site

(www.microsoft.com/downloads).

Installation procedure

This section describes the procedure used to complete a typical installation for the MiCollab Desktop

Client from a computer that has administrator permissions and access to the software. For custom

installation options, see “Install custom options” on page 155

The installation wizard requires the user to provide just one parameter during installation: the FQDN of the MiCollab Client Service. The FQDN is provided in the Welcome E-mail message (see

page 110) that you generate at the end of the provisioning process.

Notes:

•

For user level step-by-step basic installation instructions for desktop and mobile clients, go to

“MiCollab Client Considerations:” on page 125

•

The “Run Setup Wizard” command previously in the MiCollab Desktop Client Main menu is no longer required and was removed in MiCollab Client 5.1.

To install the MiCollab Desktop Client:

Close all Windows applications on the computer.

Install the Microsoft .NET Framework on the user’s computer (see page 111).

Click the link provided in the Welcome E-mail message to access the client software.

In the File Download dialog box, click Run to launch the client download.

In the Security Warning dialog box, click Run to launch the client installer. The Welcome dialog box appears.

Click Next.

Note:

If the Microsoft .NET Framework is not detected on the computer, you are prompted to download and install it. You must restart the MiCollab Desktop Client installation following the installation of the .NET Framework.

Select I accept the terms of the License Agreement, and then click Next.

Select an installation type and then click Next. Options include:

• Typical Install: Includes the MiCollab Desktop Client, Dial From IE, and the PIM extensions for the PIMs that are installed on the user’s computer (Outlook, Lotus Notes, or ACT!), the

Google, Office 365, or Microsoft Exchange Server information for the user.

111

MiCollab Client Administrator Guide

• Complete Install: Includes all of the Typical Install components and the MiCollab Client

SDK.

• Custom Install: Installs the MiCollab Desktop Client and allows the user to deselect or

select optional components (see “Install custom options” on page 155

Type the Fully Qualified Domain Name for the MiCollab Client Service in the box. The FQDN

is provided in the Welcome E-mail message (see “Welcome E-mail message” on page 110

10. Select a Default Language, and then click Next.

11. Click Install.

The MiCollab Desktop Client software is installed on the computer.

12. Click Finish to complete the installation process.

By default the MiCollab Desktop Client launches automatically.

Custom installation options

If you do not want to use a software distribution point for the client software, the following options are available for MiCollab Client installation:

•

IntelliMirror below

•

“Logon Script” on page 113

•

“SMS” on page 113

•

“Group policy” on page 113

•

“Citrix deployments” on page 113

IntelliMirror

Microsoft

IntelliMirror

management technologies can be used with Windows Installer to deploy and manage the installation of Mitel MiCollab Client. Two policies must be addressed when deploying

MiCollab Client for IntelliMirror:

• User Data Management

• Software Installation and Maintenance.

MiCollab Client persists user settings such as window settings, the call log, history, personal contacts, and favorites. These settings are saved in the user’s Application Data folder.

For deployment, MiCollab Client should be assigned to users such that when a MiCollab Client user logs in to a computer that does not have MiCollab Client installed, MiCollab Client gets installed.

Note:

If the site prevents software installations to be performed by the user, automatic upgrades of the

MiCollab Client deployed by IntelliMirror will fail during the process. Instead, use your current installation mechanism to deploy any client upgrades.

112

Installation and Configuration

The MiCollab Client IP property should be set using an installer transform (see “Creating a transform” on page 115

For more information see the Step-by-Step Guide to Software Installation and Maintenance

(http://technet.microsoft.com/en-us/windowsserver).

Logon Script

The Windows Script Host can also be used to create a logon script for deploying MiCollab Client.

Logon scripts use the same installation techniques as the software distribution point, except the mechanism used to run the installer is a script rather than an Explorer shortcut. The logon script is set through an Active Directory Group Policy. An example of a logon script that will install MiCollab

Client might be

Set oShell = CreateObject(“Wscript.Shell”) oShell.Run msiexec /i /q UnifiedCommunicatorAdvanced.msi

See the Windows Management Instrumentation site

(http://msdn2.microsoft.com/en-us/library/aa286547.aspx) for more information on scripting.

SMS

Where scheduling, inventory, status, reporting, and support for deployment across a wide area network is required, Microsoft recommends using Systems Management Server 2003 (SMS).

Again, see the syntax shown for Software Distribution Point to create the installer command that

SMS will run to install MiCollab Client on the client computer. See Systems Management Server

Home (http://www.microsoft.com/smserver/) for more information on SMS.

Group policy

You can create a Group Policy object to deploy MiCollab Clients. For a network install, the installer can be assigned to users with a Group Policy object (GPO). The GPO should install the software from an administrative image installed on a network share. For a detailed explanation on how to install software using an Active Directory Group Policy, see Step-by-Step Guide to Software

Installation and Maintenance (http://technet.microsoft.com/en-us/windowsserver).

Citrix deployments

The MiCollab Client can be deployed using the Citrix delivery system. MiCollab Client supports both

Desktop mode and Web mode. See

“MiCollab Desktop Client Requirements” on page 73 for

supported versions.

The following restrictions apply when the client is running on a Citrix server:

SIP Softphone on Citrix environment:

• Citrix supports the MiCollab Desktop Client SIP softphone on Citrix Xenapp 7.6 SP3 and above.

• Media is passed through the Citrix server, resulting in bandwidth limitations in terms of the number of concurrent audio connections (currently 25) and is not recommended for video.

113

MiCollab Client Administrator Guide

• The SIP softphone uses the "audio features" of Citrix. Therefore, it is recommended that you use Citrix specified Audio policy settings. For optimum bandwidth consumption, set Audio quality to "Medium".

• Refer to the follow information on the Citrix website for details:

"Enable and Manage Client Audio Settings for the Citrix Receiver using a Group Policy" in

Citrix documentation.

"Audio Features" under XenApp and XenApp 7.6 documentation

• Only Audio calls are supported (not Video calls).

• Softphone audio is supported through the server and is not peer-to-peer. Peer-to-peer is not supported.

• On a Citrix receiver client, the user should permit the use of local microphone and speaker when prompted by the Citrix client. If the local microphone and spearker are disabled, the softphone may not work properly.

Access to Citrix-based resources only

MiCollab Client cannot access resources that reside on the client workstation. This includes the local file system, PIMs, and instant messaging clients. To be accessible to MiCollab Client, these resources must reside on the Citrix server:

• PIM integration: MiCollab Client integrates normally with PIMs that are running on the Citrix server.

• Exchange Server integration: MiCollab Client integrates normally with the Microsoft Exchange server.

• Knowledge Management: The Knowledge Management feature works the same on Citrix, provided the indexed Outlook folders and file paths are on the Citrix server.

• Instant Messaging: MiCollab Client integrates normally with Microsoft Messenger and Microsoft Office Communicator (LCS) clients that are running on the Citrix server.

For information about setting up Citrix servers to run MiCollab Client, see the Citrix product documentation.

Installer transforms

Windows Installer packages can be customized with installer transforms. Installer transforms are files that, when run with the installer package, modify certain installation properties and application features.

The MiCollab Client installer package requires that the MiCollab Client Service IP property be set at install time. If the installer package is executed without any command-line parameters setting this property, the installer package prompts the user for it.

Alternatively, a transform can be created that will set this property. The transform can be specified in the command string used to install MiCollab Client or it can be specified when installing software using an Active Directory Group Policy.

114

Installation and Configuration

If the server IP property is set in this way, the installer can be run with reduced or “silent” user interaction. More customization options can be found in the Windows Installer SDK documentation

(http://msdn2.microsoft.com/en-us/library/aa367988.aspx).

Creating a transform

You can use third-party tools to create a transform. These tools are usually bundled with MSI authoring tools. However, the transform is simple and can be created with a simple script using COM components deployed on platforms supported by MiCollab Client. The following script will create a transform called transform.mst.

Note:

The following script is an example based on documentation provided by Microsoft. It is not a Mitel supported script and is provided for information only.

Option Explicit

Dim wi, basedb, db, fs, sh, infile, ip, sql, view

Const msiTransformValidationLanguage = 1

Const msiTransformErrorNone = 0

Const msiOpenDatabaseModeReadOnly = 0

Const msiOpenDatabaseModeTransact = 1

Set sh = CreateObject(“WScript.Shell”)

If WScript.Arguments.Count < 2 Then

WScript.Echo “Usage: maketransform.vbs <input file> <ya server ip>”

WScript.Quit

End If

Set fs = CreateObject(“Scripting.FileSystemobject”)

Set wi = CreateObject(“WindowsInstaller.Installer”) infile = WScript.Arguments(0) ip = WScript.Arguments(1) fs.CopyFile infile, “tmp.msi”

Set basedb = wi.opendatabase(infile, msiOpenDatabaseModeReadOnly)

Set db = wi.opendatabase (“tmp.msi”, msiOpenDatabaseModeTransact) sql = “INSERT INTO Property (Property.Property, Property.Value) VALUES” & _

“('UC_SERVER_HOSTNAME', '" & ip & “')”

Set view = db.OpenView(sql) view.Execute

db.Commit

db.GenerateTransform basedb, “transform.mst”

115

MiCollab Client Administrator Guide

db.CreateTransformSummaryInfo basedb, “transform.mst”,_

msiTransformErrorNone, msiTransformValidationLanguage

Set view = Nothing

Set db = Nothing

Set wi = Nothing

Set sh = Nothing fs.DeleteFile “tmp.msi”

Set fs = Nothing

The output is transform.mst and this transform file can be used to modify a MiCollab Client installation.

116

Installation and Configuration

Installer properties

The following table lists the MiCollab Client installer properties that may be modified to create custom deployments.

Property

UC_SERVER_HOSTNAME

UC_LANGUAGE

Table 18: Modifiable installer properties

Valid Values

A valid IP address or computer name.

en-US North American English en-GB British English nl-NL Dutch fr-CA Canada French de-DE German pt-BR Brazilian Portuguese it-IT Italian es-MX Latin American Spanish fr-FR European French es-ES European Spanish sv-SE Swedish zh-CN Simplified Chinese zh-TW Traditional Chinese

Description

The PC running the

MiCollab Client management software where the user’s account is configured.

This is the language

MiCollab Client

will use on its first startup.

117

MiCollab Client Administrator Guide

Install MiVoice for Skype for Business Client

Skype for Business deployment is supported in various options as seen in the table below. MiVoice for Skype for Business is a plugin which integrates seamlessly with Skype for Business application.

Notes:

•

MiVoice for Skype for Business is supported on MiCollab deployed MiCollab Client only.

•

MiVoice for Skype for Business Deskphone only users: those users only require the MiCollab

Desktop Client SDK feature.

•

MiVoice for Skype for Business Softphone only users OR those users with a Softphone and an associated Deskphone will require the Softphone feature in addition to the MiCollab Desktop

Client SDK feature (see “ MiCollab Client licensed features” on page 11 ).

Skype for Business

Server

Local

Cloud (Office 365)

Table 19: Skype for Business Deployment Options

MiVoice Business

Local

Cloud

Local

Cloud

MiCollab Client Service

local

Cloud

Local

Cloud

Supported (Yes/No)

Yes

Information E-mail

Note:

Skype for Business should be installed prior to installing MiVoice for Skype for

Business.

Once the MiVoice for Skype for Business account is created on the MiCollab Client Service, the user will receive a Welcome E-mail with the following information:

• User client Login ID (Login ID is driven from Active Directory - AD) and password

• Link to download the MiVoice for Skype for Business plug-in software installer

• The Server Fully Qualified Domain Name - FQDN (host name)

• User account information (desk phone, softphone, voice mail, etc...)

• Teleworker (MiVoice Border Gateway) IP Address.

MiVoice for Skype for Business installer

The following components will be installed on the user’s computer (may vary if 2010 or 2013 clients)

- the following are major components only and not the complete component list:

• MiVoice for Skype for Business executable file

• Mitel MiCollab Client and Skype for Business client Software Development Kit - SDK components

(as .dll files)

• Mitel MiCollab Client headless client

118

Installation and Configuration

• MiVoice for Skype for Business service

• Configuration settings (like setting to indicate that MiCollab Client shall run without a UI)

Installation wizard

• All the components of MiVoice for Skype for Business will be installed and user will not be able to select/deselect Plug-in components for installation.

• Installer will prompt user to enter configuration options like MiCollab Client Service FQDN etc.

• Installer will prompt user to select default language.

• There will be no desktop/start menu icon specific for MiVoice for Skype for Business client installed on the computer as this application will be launched via Skype for Business.

• User can re-run the installation wizard. This will allow user to change configuration options like

MiCollab Client Service FQDN or repair the damaged installation.

Notes:

•

In the event that another version of MiCollab Client (or MiVoice for Skype for Business) is already installed on the user’s computer, the plugin installer will automatically uninstall the

MiCollab Client and install the plugin.

•

Ideally MiVoice for Skype for Business installation shall be done after the installation of Skype for Business client only. Installing the Skype for Business client after plug-in installation may override settings/configuration files of plugin and is not recommended. User should re-install the MiVoice for Skype for Business if problem are encountered in this scenario.

•

The user must have installation permissions on the computer or provide the administrator credentials when prompted.

119

MiCollab Client Administrator Guide

Deploy MiCollab for Mobile Client

MiCollab Client 7.0 introduces a new blade which allows for the simplified deployment of MiCollab for Mobile. This solution is supported in integrated and co-located MiCollab Client deployments.

End users are no longer required to enter configuration settings such as server and SIP credentials.

Administrators configure these settings and MiCollab for Mobile clients are deployed Over the Air

(OTA). The administrator portal enables administrators to:

• deploy large groups

• leverage profiles

• download multiple files to the clients

• update clients

A new customizable deployment e-mail with end user credentials is available.

For more information, see the MiCollab Client Deployment help file.

For more information about MiCollab UC- Client deployment, see See “MiCollab UC-Client

Application” on page 203.

Remote User Configuration

After the MiCollab Desktop Client is installed on a computer that resides outside of the local network, you must configure remote user access to MiCollab Client. Configuration procedures differ for each

PBX. See the configuration information that applies to the site’s PBX:

•

“MiVoice Business PBX Configuration for remote users” below

•

“MiVoice Office 250 PBX configuration for remote users” on page 124

TCP/TLS to UDP Connector

The TCP/TLS to UDP connector is a feature introduced in MiVoice Border Gateway 7.1 SP2 as part of MiCollab 4.0 SP2. This feature is also available in MiVoice Border Gateway 8.0 as part of MiCollab

5.0. This connector enables MiCollab Client desktop and mobile clients to configure the SIP softphone to use TCP or TLS protocol when connected to MiVoice Border Gateway. MiVoice Border

Gateway will convert the TCP or TLS protocol to UDP when communicating to the MiVoice Business or the MiVoice Office 250 PBX. Using the TCP/TLS protocol for SIP softphone eliminates many of the Network Address Translation issues encountered when using UDP for SIP signalling.

This connector is supported in the MiVoice Border Gateway in server gateway mode and in DMZ setup (

“MiVoice Border Gateway and Remote Proxy Services configuration” on page 93 ). This

connector is automatically enabled or disabled when MiCollab Client support on MiVoice Border

Gateway is enabled or disabled.

Note:

This connector is supported only for MiCollab Client SIP softphones and there is no support for any 3rd party SIP phones. The MiCollab Client s must enable teleworker mode for the SIP softphone to use this connector on the MiVoice Border Gateway when the signalling protocol is set to TCP or TLS.

120

Installation and Configuration

MiVoice Business supports TCP and TLS for SIP in MiVoice Business 6.0 and later versions. The default SIP protocol used by different MiCollab Client s are shown below:

MiCollab Desktop Client version 6.0: defaults to TCP when connecting to MiVoice Business directly. Defaults to UDP in teleworker mode. Defaults to UDP when connecting to 5k PBX.

iOS (iPhone) and Android MiCollab Client s version 5.1: defaults to UDP in all modes.

For MiVoice Office 250 PBX this connector on MiVoice Border Gateway has to be used when TCP or TLS protocol is enabled in the SIP softphone configuration in the MiCollab Client s. MiVoice Office

250 PBX does not support SIP over TCP or TLS.

Note:

Mitel recommends that users always set the iOS (iPhone) clients in teleworker mode and set the protocol to TCP or TLS when using MiVoice Border Gateway 7.1 SP2 or later with TCP to UDP connector enabled.

Otherwise, if the SIP protocol is set to UDP, the iOS operating system will not wake up the MiCollab

Client application during an incoming call (while MiCollab Client application is in the background).

MiVoice Business PBX Configuration for remote users

This section describes the required configuration for remote users connected to an MiVoice Business

PBX. Remote User Configuration includes:

•

“MiCollab Desktop Client softphone and teleworker settings”

below

•

“MiVoice Border Gateway device configuration” on page 122

For additional port information, see the Mitel MiCollab Client Engineering Guidelines.

MiCollab Desktop Client softphone and teleworker settings

Before users can use MiCollab Client softphone features from MiCollab Desktop Client, they must configure as per options under: Main menu – Configuration – Softphone Settings.

Additionally, in Teleworker mode, the remote MiCollab Client uses a secure SSL connection with the MiVoice Border Gateway for all communication between the client and the MiCollab Client

Service.

Make sure that you provide the information in

Table 20 MiCollab Desktop Client softphone settings

to users so that they can configure the Teleworker fields. Refer users to the online help for instructions.

Field

Enable SIP softphone

Table 20: MiCollab Desktop Client softphone settings

Description

Enable this option if you wish to use the SIP softphone on this MiCollab Desktop

Client

SIP softphone DN Select SIP softphone extension (Directory Number) to use from pull-down menu.

Page 1 of 2

121

MiCollab Client Administrator Guide

Field

SIP Connection

Table 20: MiCollab Desktop Client softphone settings

Description

This number is used on multiple devices

Options: Default, TCP, UDP and TLS. Leave at Default.

Note: When connected to either MiVoice Office 250 or MiVoice Business PBX,

TCP and TLS protocols are only supported when the Use Teleworker for soft phone is enabled.

SIP TCP and SIP TLS are supported for endpoints (not trunks) as of MiVoice

Business 6.0.

(Also see

“TCP/TLS to UDP Connector” on page 120

This feature allows the user to use their SIP extension on other devices such as an iPhone or Android devices. With this option selected, they can register their

SIP softphone extension from another device if licensed to do so

Users can leave at default or select desired devices to suit their needs.

Microphone, Speaker,

Alerts, Call control

Video Camera

Ringtones

Use Teleworker for softphone

Teleworker Gateway IP

This option will appear only if Enable SIP softphone (above) is set.

Select which camera to use from the pull-down menu. Select the video data rate or leave at default based on the camera selected.

Use system default or browse to desired ringtone, click play to test.

If this flag is enabled, the Minet or SIP Softphone will always connect to the

MiVoice Border Gateway.

MiVoice Border Gateway IP or FQDN Address is mandatory if Use Teleworker

for softphone is set.

The IP address should be in the form of xxx.xxx.xxx.xxx.

Page 2 of 2

Notes:

•

Teleworkers equipped with both a Mitel deskphone and a Mitel softphone will use two teleworker licenses.

•

A MiNet Softphone and SIP Softphone cannot be active at the same time.

MiVoice Border Gateway device configuration

To provide access to remote users accessing the MiCollab Client Service through the MiVoice Border

Gateway, you must add or enable a device for each remote user:

•

“To add or enable MiNet devices in the MiVoice Border Gateway for remote MiVoice Business users:” below

•

“To add or enable SIP devices in the MiVoice Border Gateway for remote MiVoice Business users:” on page 123

Note:

Verify that SIP support is enabled on the MiVoice Border Gateway (it is disabled by default).

Go to Configuration Settings, under SIP Options.

122

Installation and Configuration

To add or enable MiNet devices in the MiVoice Border Gateway for remote MiVoice Business users:

Open a Web browser and navigate to the MSL Server Manager URL (for example,

https://<MSL_server_FQDN>/server-manager

) where the MiVoice Border Gateway/Remote

Proxy Services are installed. The server manager log in page appears.

Under Applications, click MiVoice Border Gateway.

Click Services > MiNet Devices.

Add or enable the softphone and desk phones that need to connect to the MiCollab Client Service through the MiVoice Border Gateway.

You must configure a Device ID on the MiVoice Border Gateway for each MiNet Directory

Number.

Note:

The Device ID is a network MAC address consisting of 6 hexadecimal numbers separated by colons. It starts with a1:21:00 and contains the Directory Number within the digits. The 0 (zero) digit is replaced by the letter a, the * symbol corresponds to the letter b and the # corresponds to the letter c.

For example, a Directory Number of 71*0#8 would have a Device ID of a1:21:00:71:ba:c8

To add a device:

Click Add MiNet Device to add a device to the MiVoice Border Gateway. Configure the device as described in the online Help.

Click Save.

To enable a device:

Click the device ID. The device details page appears.

Click Edit.

Select the Enabled option and then click Save.

To add or enable SIP devices in the MiVoice Border Gateway for remote MiVoice Business users:

Open a Web browser and navigate to the MSL Server Manager URL (for example,

https://<MSL_server_FQDN>/server-manager

) where the MiVoice Border Gateway/Remote

Proxy Services are installed. The server manager log in page appears.

Under Applications, click MiVoice Border Gateway.

Click Services > SIP Devices.

123

MiCollab Client Administrator Guide

Add or enable the SIP softphone that need to connect to the MiCollab Client Service through the MiVoice Border Gateway. Every unique SIP softphone number used for MiCollab Mobile and MiCollab Desktop clients will need to be added to the MiVoice Border Gateway SIP device services.

To add and enable a SIP device:

Click Add a SIP Device to add a device to the MiVoice Border Gateway. Configure the device as described in the online Help.

Select the Enabled option and then click Save.

MiVoice Office 250 PBX configuration for remote users

Remote MiCollab Client users connected to a MiVoice Office 250 PBX access the MiCollab Client

Service through the site’s firewall ports. Configure the firewall ports to provide access to the MiCollab

Client Service and the integrated Mitel applications as documented in the Mitel MiCollab Client

Engineering Guidelines.

Softphone (SIP-based) specific considerations

To configure softphone (SIP-based):

Licensing requirements (for MiCollab Desktop, MiCollab for Mobile clients):

For the MiCollab Desktop Client, the existing “Softphone” license will cover both the Minet softphone and the new SIP-based softphone.

The mobile clients must have the “Mobile SIP Softphone” license in order to configure and use the SIP softphone.

Notes:

•

On the MiCollab Client Service: you must first select MiCollab for Mobile for Smart

Devices license then select Mobile SIP Softphone.

•

The MiCollab Mobile for Smart Devices was previously known as the Locator.

Quality of Service (QoS):

The softphone supports L3 quality of service (QoS) values as per the Table below. These values are used for audio, SIP signaling, and video streaming.

These values are not accessible on the MiCollab Desktop Client but do appear on the Android and iOS clients under Softphone Advanced Settings at their default values.

Service Class

Telephony (Voice)

Signaling

Multimedia Streaming (Video)

L3 Values

46 (EF)

24 (CS3)

34 (CS4)

124

Installation and Configuration

Admin Considerations:

Before a MiCollab Client can use a SIP Softphone, it must be configured on the PBX, MiVoice

Border Gateway, MiCollab Client sever, and MiCollab Client. For all MiCollab Client s, the softphone will be available for use once MiCollab Client is launched and running.

Also see

“High level installation and configuration procedures” on page 81

PBX Considerations:

Note:

MiVoice Business 5.0 SP2 or newer release is required.

MiVoice Office 250 running 5.1 or later release is required.

The account code dialing is not supported for SIP softphone on MiVoice Business or MiVoice

Office 250 PBX.

MiVoice Office 250 specific: On the MiVoice Office 250 provisioning system, the admin can create a SIP device and assign it to the user. This is necessary to support the softphone on MiCollab

Desktop Client and mobile devices.

Note:

By default, a MiCollab Client SIP softphone on a MiVoice Office 250 will only allow one incoming call at a time. To handle multiple incoming calls on the MiVoice Office 250, go to the SIP phone group, On-line monitor, Maximum number of calls, then set to two.

MiVoice Business specific: To ensure proper functionality, there are two critical changes that

MUST be made on MiVoice Business when configuring a MiCollab Client SIP Softphone:

First, you must select a Device Type of MiCollab Client Endpoint.

Second, you must add at least one additional line. This is accomplished by adding a key with a

Line Type of Multicall, a Button Dir. Number matching the number of the device, and Ring Type of Ring.

MiVoice Border Gateway and Teleworker Considerations:

Softphone users outside of the PBX/MiCollab Client network will require a connection through an MiVoice Border Gateway for both data and audio/video real-time streaming.

See

“MiVoice Border Gateway and Teleworker Considerations:” on page 126 ,

“MiVoice Border Gateway and Remote Proxy Services configuration” on page 93

“Remote User Configuration” on page 120 .

MiCollab Client Service Considerations:

Under Accounts tab: select Phone Numbers, add SIP Softphone type, Number and Video

Capable (if supported).

Note:

Step 5 is only required if the account was not synchronized, i.e. in the event the account(s) was created manually in MiCollab Client Service for 6.0.

MiCollab Client Considerations:

125

MiCollab Client Administrator Guide

Follow the procedures for the installation, configuration and testing of the MiCollab Client

Softphone for each client as listed below. For additional assistance on features, go to each client online Help or http://edocs.mitel.com/default.htm

MiCollab Desktop Client - see “Softphone Configuration - MiCollab Desktop Client” on page 127

Notes:

•

On the MiCollab Desktop Client, in order to use SIP-based video calls, enable the availability for video calls under Dynamic status (Manage Statuses).

•

A new checkbox has been added in the Teleworker settings screen on each client that indicates

“Prefer Teleworker Connection”. This flag will alert the client to always attempt to connect the softphone through the TW.

•

Mitel recommends setting up the softphone as a part of a ring group to avoid missing incoming calls due to the following condition:

•

Due to Apple iOS application management, the MiCollab for Mobile application for iPhone may stop running while in the background (consistent with iOS behavior on other iOS Apps). The result is that a MiCollab Client application user may be unaware that the MiCollab Client application has stopped receiving incoming softphone calls and chat messages.

• Participation in a Ring Group will accommodate missed calls but not missed chat messages.

• Also see MiVoice Business

“Personal Ring Group Assignment form” on page 85

and Mi-

Voice Office 250

“Users” on page 88 .

Migration from Minet Softphone on MiCollab Desktop Client

A few scenarios to consider:

Minet Softphone: The MiCollab Desktop Client will automatically use the Minet softphone when the user has the “Softphone” license, a Minet softphone DN, and no SIP DN.

SIP Softphone: The MiCollab Desktop Client will use the SIP softphone when the user has the

“Softphone” license, a SIP DN, and no Minet softphone DN. Note that in this case, the user must configure and enable the SIP softphone in the MiCollab Desktop Client (i.e., on first startup, the MiCollab Desktop Client will not automatically start the SIP softphone).

Minet or SIP Softphone (depending on user configuration): When the user has the “Softphone” license, a Minet softphone DN, and a SIP DN, the softphone used by the MiCollab Desktop Client depends on whether or not the user has configured the MiCollab Desktop Client to use the SIP softphone. On first startup, the MiCollab Desktop Client will use the Minet softphone. If the user wants to use the SIP softphone, the user must configured and enable the SIP softphone (note that a restart of the client may be necessary). After the SIP softphone has been configured and enabled, the SIP softphone will automatically be used by the MiCollab Desktop Client on subsequent restarts.

If the user wants to switch back to the Minet softphone, he must disable the SIP softphone and restart the client.

MiVoice Border Gateway and Teleworker Considerations:

Softphone users outside of the PBX/MiCollab Client network will require a connection through an

MiVoice Border Gateway for both data and audio/video real-time streaming. It is expected that the normal setup for such a configuration involves configuring the fully-qualified domain name (FQDN) of both the PBX and the MiCollab Client Service to resolve to the IP address of the MiVoice Border

Gateway when outside the corporate network. However, since an FQDN may not be used on the

126

Installation and Configuration

PBX or MiVoice Border Gateway in all cases, the clients need to support both an internal and external address/hostname for connection.

The clients will always attempt to connect to the local address first and then subsequently try the remote address unless the client is configured to only use the remote address.

The MiVoice Border Gateway IP/hostname and username/password is configurable at the client level.

The SIP softphone should be configured as a normal SIP teleworker device on the MiVoice Border

Gateway.

Note:

MiCollab Client profile can have different credentials for Teleworker mode and non-Teleworker mode. It is strongly recommended that the credentials be more secure when connecting to an

MiVoice Border Gateway.

Softphone Configuration - MiCollab Desktop Client

The following step-by-step procedure will guide you through installing the MiCollab Client software application onto your MiCollab Desktop Client device and testing basic softphone call functionality.

For the purpose of this exercise, a SIP softphone will be used (softphone definition, see Note

1 page 130 ).

Requirements:

• Wifi or Data connectivity established for your computer.

• Mitel MiCollab Client Account Credentials e-mail from your system administrator (also known as Welcome E-mail).

Installing the MiCollab client application

1. From your desktop device, follow the instructions from your Welcome E-mail to download the MiCollab Desktop Client software. A link has been provided, for example: https://<your server>/ucs/dl/UnifiedCommunicatorAdvanced.msi.

2. In the File Download dialog box, click Run to launch the client download.

3. In the Security Warning dialog box, click Run to launch the client installer.

The welcome dialog box appears.

Then click Next (see

Note 2 page 130 if Microsoft.NET Framework is not detected on your

computer).

4. Select I accept the terms of the License Agreement, and then click Next.

5. Select Typical Install and then click Next.

6. Type the Fully Qualified Domain Name for the MiCollab Client Service Hostname in the box as provided in your Welcome E-mail.

7. Select a Default Language, and then click Next. On the next screen, click Install.

8. The MiCollab Desktop Client software is installed on your computer. Click Finish to complete the installation process. By default the MiCollab Desktop Client launches automatically.

9. Next you will be prompted to login.

10.Enter your Credentials as per your Welcome E-mail then click Log in:

• Login ID

127

MiCollab Client Administrator Guide

• Password

Enabling your softphone

11.The MiCollab Client main screen will appear.

Go to the Main Menu by selecting the drop-down symbol next to the name.

12.Select Configuration, and then select Softphone Settings.

There are several fields unique to your individual configuration.

• Click Enable SIP soft phone.

•

SIP soft phone DN: from the pull-down menu, select SIP softphone DN (Directory

Number).

•

SIP Connection Options: Default, TCP, UDP and TLS. Leave at Default unless advised otherwise by your system administrator.

• This number is used on multiple devices (xxxxx) is OFF (unchecked) by default. Tap the check box if you plan to use this softphone number on more than just your MiCollab

Desktop Client For example if you plan to use this number on another client such as your iPhone or Android client.

• Other options such as Microphone, Speaker. Alerts, Call Control and Ringtone can be left at default (can be modified later).

• Video Camera: will only appear if Enable SIP softphone is checked. Select one camera device if you plan to use video with your softphone.

• Use Teleworker for softphone: enable this option if you plan to use your MiCollab

Desktop Client softphone off your corporate network. If enabled, enter the Teleworker

Gateway IP address or FQDN as provided by your system administrator.

See

note 3 page 130

• Click OK.

13.Go to the Main Menu and then select Manage statuses.

• From the pull-down menu Make my calls from: select your softphone number.

• From the pull-down menu Send my calls to: select My Ring Group or leave at default.

• From the pull-down menu Video calls: select Accept if you plan to use your softphone for Video calls (including MiCollab Audio, Web and Video Conferencing and UC360 devices).

• Click Save.

See

Note 4 page 130 for more information on these fields.

Testing your softphone

14.From the Home screen.

• Select the softphone from the pull-down menu to originate your call.

As a test, enter an extension number and select Call.

A Call screen will be displayed for the duration of the call.

15.Answer the call at the far-end.

• Test to ensure that you have 2-way audio and tap End Call.

16.This step is optional:

128

Installation and Configuration

• If both your device and the far-end device support video, tap the video icon to escalate your audio call to a video call.

• The far-end must also tap the start video button to get 2-way video.

17.Have the far-end call you at your Softphone number, answer the call and test for 2-way audio.

Tap End call.

Having problems making or receiving a call, see

Note 5 page 130 .

To leverage all the functionality of MiCollab Client or need Help, press F1 or select Help from

129

MiCollab Client Administrator Guide the Main Menu or go to http://edocs.mitel.com/default.htm

Notes:

1. SIP softphone definition: The MiCollab Client for Mobile devices (such as iPhone and

Android) use a SIP-based softphone. SIP stands for Session Initiation Protocol, which is an industry-wide standard offering a feature-rich experience and new functionality to your

Mobile device. The MiCollab Desktop Client can be configured with a Mitel softphone or a

SIP-based softphone. In this exercise, a SIP-based softphone will be used.

2. If the Microsoft.NET Framework is not detected on the computer, you are prompted to download and install it. You must restart the MiCollab Desktop Client installation following the installation of the .NET Framework.

3. Teleworker definition: remote or off-premise worker who needs connectivity to the office.

Internet connectivity is often accomplished by the use of the public network internet. If you

plan to use your MiCollab Desktop Client softphone outside of your company's

corporate network, you must configure Teleworker Settings. When the Teleworker

Settings are configured and enabled, the softphone will connect and register to the Teleworker server regardless if you are inside or outside your corporate network.

Non-Teleworker: Connecting via VPN from outside is considered being on the corporate LAN.

“Most Desktop users will not be Teleworkers”.

4. Manage Statuses (part of Dynamic Status feature) allows you to customize call handling based on your particular MiCollab Client status. For example, you may choose to make and receive calls using a certain number while In the Office but utilizing a different profile while

Working from Home. This is just one of the many features of MiCollab Client.

5. Several issues may arise preventing you from making or receiving a call, such as:

• Lost network connectivity - a message trying to reconnect will appear.

• Softphone de-activated or registration taken by another device. A notification pop-up will appear near the top of the screen, bring cursor over the notification and click

Connect to re-activate your softphone.

• Dialing a valid number / extension? If dialing an external number, is the prefix (i.e. 8 or 9) for external calls being automatically inserted by your system, try with and without the prefix.

• Try exiting and re-launching the MiCollab Client application (Main Menu, Exit), double click on the MiCollab Client icon from your desktop.

• Still having issues, you may need to contact your system or network administrator for assistance.

Teamwork mode

To support Teamwork Mode functionality, accounts that do not have a desk phone or a softphone will by default operate in Teamwork Mode. See

“Teamwork Mode” on page 65

Server Admin portal impacts and considerations

In order to support Teamwork Mode, it is possible to have a group of user accounts with no real PBX nodes. By the same token, it is possible to have some accounts operate in Teamwork Mode (without a desk phone or softphone) while other users operate in a traditional mode with either a desk phone, softphone, or both assigned.

130

Installation and Configuration

The following MiCollab Client Service areas are impacted to support Teamwork Mode:

Enterprise Tab

There are no specific actions required on the Enterprise Tab for Teamwork Mode. However, note that the “Switch type” field is still mandatory. When creating a new enterprise that will not have any

PBX nodes and only have Teamwork Mode accounts, the switch type can be left at the default value of “Mitel Communications Director” (the value will be ignored). Otherwise, choose the switch type of your enterprise as usual.

Account Tab

The Account tab displays a PBX Node column for every account. If a user is not assigned to a PBX node or PBX Node is [None] (i.e. the user does not have a desk phone or a softphone), this column will be blank. Therefore, any account with a PBX Node column blank is considered to be in

Teamwork Mode.

A Teamwork Mode account that has a PBX Node value of [None] can be later moved to a real PBX node if they get assigned a phone on that PBX. However, an account that is assigned to a real PBX node cannot be moved back to Teamwork Mode.

Note:

When adding an account manually the PBX node must be set to 'None' for account to be in teamwork mode.

When using Active directory sync (see Synchronization MiCollab Client Teamwork Mode accounts

(i.e. those accounts with no desk phone or softphone) can be created manually in Server Admin portal or via AD/LDAP synchronization as seen below: for more information), the PBX node value

in active directory should be set to <enterpriseId>.local and no desk phone or softphone number must be assigned to the user account in active directory.

Account Details Page

To add a user in Teamwork Mode, in creating an account leave the “PBX node” field set to [None].

See “Synchronization MiCollab Client Teamwork Mode accounts (i.e. those accounts with no desk phone or softphone) can be created manually in Server Admin portal or via AD/LDAP synchronization as seen below:” for more information.

Note:

Prior to MiCollab Client 5.1, the admin was required to select a PBX node when creating an account. If there were no PBX nodes, the admin could not create accounts.

Features

There are no specific features related to Teamwork Mode. You can select any feature for a Teamwork

Mode account, however any phone or call control related features (such as Desk phone or Softphone) will be ignored. Also note that licenses for individual features such as Chat, Visual Voicemail, etc are still required.

Synchronization

MiCollab Client Teamwork Mode accounts (i.e. those accounts with no desk phone or softphone) can be created manually in Server Admin portal or via AD/LDAP synchronization as seen below:



Server Admin portal Teamwork Mode account creation:

1. From Accounts tab, select Add Account.

2. In the new Account Details page, select [None] for the PBX Node field.

131

MiCollab Client Administrator Guide

3. Fill out other fields as you would normally fill them out (if they are available).

4. Select Create to create a new Account.

5. On the newly created Account Details page, fill out any other available information if necessary, such as Contact Information or Account Settings.

Note:

You should not add any numbers under Phone Numbers since Teamwork Mode accounts shouldn’t have a desk phone or softphone and cannot do call control.

6. Select Save when finished.



AD/LDAP Synchronization Teamwork Mode account creation:

1. Fill out all fields as you would for a regular account except for the following:

Set PBX node value to <enterpriseId>.local, where <enterpriseId> is the ID of the enterprise being created and can be found on Enterprise Tab.

Do not fill out fields for desk phone and softphone.

2. Perform AD/LDAP synchronization as usual. Newly created Teamwork Mode account should show [None] for PBX Node and no desk phone and softphone numbers on that account’s

Account Details page.

Default Account Statuses

The first time a user logs into a MiCollab Client, the MiCollab Client Service creates the following list of default set of Dynamic Statuses for a Teamwork Mode user:

• In the office

• Do not disturb

• Gone for the day.

132

Installation and Configuration

Google Calendar Integration

MiCollab Client provides users with the option to integrate with Google calendar.

Licensing

This feature is available by default and no specific MiCollab Client license is necessary.

Admin Portal

MiCollab Client can support connection to one Google enterprise domain. At the enterprise level, the Administrator must select between Exchange Integration, Office 365, or Google Calendar

Integration. This selection is accomplished by selecting Calendar Integration option under the

Enterprise Tab on the Admin Portal. In addition, the Advanced Calendar Integration Settings can also be found at this same location.

Note:

MiCollab Client 6.0 release has support for Google calendar integration. If MiCollab Client 5.1 mobile clients try to connect to a MiCollab Client 6.0 server which has Google calendar integration enabled, then the calendar integration feature will not be configurable from the clients. The calendar integration configuration screen on the clients may display a message to this effect:

“Calendar integration is not enabled on the server”. To make use of Google calendar integration, the clients need to be upgraded to MiCollab Client 6.0 or later software.

Authentication and access to Google Calendar

To provide the calendar integration feature, MiCollab Client Service will access Google calendars belonging to a specific Google Apps domain. MiCollab Client uses OAuth 2.0 to access Google calendars. One of the strengths of OAuth is that MiCollab Client does not need to know your Google

Account credentials, and you can grant and revoke access permissions to MiCollab Client at anytime.

MiCollab Client administrator should setup this access as described below.

Notes:

Calendars with no sharing (Google users can control sharing on their individual calendars) will not publish free/busy information and hence their calendar availability information cannot be accessed by MiCollab Client. MiCollab Client administrators should ensure that users who want to make use of the Calendar Integration feature have shared their calendars.

The following sequence of steps will grant MiCollab Client Service the permission to access free/busy information from calendars belonging to the enterprise’s Google Apps domain (subject to sharing constraints as described above). This access privilege can be revoked at anytime (this feature will stop working if privileges are revoked) by logging into Google at: https://accounts.google.com/b/0/IssuedAuthSubTokens

For more information, please see: https://developers.google.com/accounts/docs/OAuth2WebServer#tokenrevoke

The process for granting Google calendar access to applications is described in https://developers.google.com/accounts/docs/OAuth2ForDevices. Below are the sequence of steps that need to be performed by the MiCollab Client administrator. For the latest information, please see the Google URL for OAuth2ForDevices (stated above).

133

MiCollab Client Administrator Guide

From a browser, navigate to https://code.google.com/apis/console#access and login using your

Google Apps credentials.

You can login as the Google Apps domain SuperAdmin or as a Google Apps domain user. Each of these can affect how much information MiCollab Client can access from Google calendars:

• Login as SuperAdmin – This will allow MiCollab Client to access calendar free/busy information even when individual users have not shared their calendars.

• Login as a user – This will allow MiCollab Client to access calendar free/busy information for all the calendars that have been shared at least within your Google Apps domain.

Note:

In either of the above cases, MiCollab Client will only present the calendar free/busy information

(the start and end times of events). Other details (such as Event subject, content, participant list, etc.) will not be visible to MiCollab Client users even if MiCollab Client is able to access such information from Google calendar.

If you haven’t registered any applications before, click Create Project and accept the Terms of

Service. Otherwise, click Create Project.

Type the Project Name and click Create.

Click APIs from the APIs & auth menu and turn Calendar API to the ON position. This enables

Google Calendar API access.

Click Credentials. Click Create new Client ID under the OAuth section.

Select Installed application as the Application Type. Click Configure consent screen.

Enter the desired information and click Save. The Create Client ID window is displayed.

Select Installed application as the Application Type. Select Other as the Installed Application

Type. Click Create Client ID.

Google generates a Client ID and Client Secret. These pieces of information are required by

Google to track the number of calendar access requests made on behalf of your Google Apps domain, and to throttle/limit the requests and protect the Google Apps infrastructure from overload.

Copy the Client ID and Client secret.

Login to MiCollab server-manager and go to the Installation Application tab under Configuration > Google Apps. Paste the Client ID and Client Secret provided in the previous step. The product name can be left blank.

10. Click Save and Generate Authorization Code. MiCollab now communicates with Google to obtain consent URI: If the information you entered was incorrect (for example, due to some error in copy-pasting), the MiCollab page will display a brief error message. If this happens, make sure to copy the information from Google console correctly and try again.

11. If the Client ID and Client Secret were valid, MiCollab communicates with Google and obtains an authorization code (displayed in bold), and a link to Google.

Copy the authorization code and click the link.

12. Paste the code and click Continue. You will now be presented with a form to allow MiCollab

Client to access your Google calendar. Click Accept.

134

Installation and Configuration

Once you allow access, within a minute or so, MSL will poll Google and obtain OAuth2 access token. Once this operation is successfully completed, you may logout of your Google account and return to MiCollab Client Service-manager.

When these steps are complete, to verify whether MiCollab Client has access to the tokens, go to Server-Manager -> MiCollab Client Services -> Perform Server Diagnostics -> Calstatus. At the bottom of that page, MiCollab Client lists the recent OAuth2 events that it received.

To enable Google Calendar Integration on the server:

Select the desired enterprise

Under Calendar Integration, select Google from drop down Calendar Type list

Click the Enable calendar integration checkbox

Click Test Connection.

Once the connection is successful, apply changes and save the enterprise details. Now the MiCollab

Client users in that enterprise can enable Google calendar integration by providing their calendar

ID from their respective MiCollab Client s.

Changes to clients

Google Calendar setting

Note:

Google calendar has some options to control which events are displayed in the calendar and which are not. These options can be accessed from Google calendar's settings webpage. These options include (but are not limited to) “Show events you have declined”, “Only show invitations to which I have responded”, etc. While these options control some aspects of how events are displayed in your Google calendar, MiCollab Client's Google calendar integration status may not be controlled by them. More specifically, MiCollab Client reflects your Google calendar's Free/Busy status only, and does not necessarily correspond to what events are visibly “shown” to you in your

Google calendar. Even though some events are hidden from your view in the Google calendar (in order to reduce clutter, etc.) if those events influence the calendar's free/busy status (by default, events will mark your calendar as busy for the duration of the event unless they are declined, or are marked explicitly as “Available”), then MiCollab Client will reflect that status.

Calendar whose availability information is needed must be shared at least within the Google Apps domain. The calendars can be public, or shared with all event details visible, or shared with only free/busy information visible.

This setting can be accessed on Google calendar under “My calendars” -> <Calendar Name> ->

Click on the down arrow on the right -> Calendar settings ->Share this calendar -> Share this calendar with others. The image below shows a calendar that has shared its free/busy information.

135

MiCollab Client Administrator Guide

Calendar ID

The clients should collect user’s Google calendar ID and provide the information to the server. The server will then poll that calendar.

User can find the calendar’s ID as follows:

My Calendars, hover on your calendar name. To the right of the calendar name, you will see a drop-down arrow. Click that and select “Calendar settings”.

The “Calendar settings” page shows the Calendar ID. Provide this ID to the MiCollab Client.

Note:

Google calendar has a relatively new feature called appointment slots. They can be created from the same UI as creating calendar events, but by choosing Appointment slots instead of Event. For this release of MiCollab Client (v6.0), Appointment Slots created in Google calendar will not be reflected as MiCollab Client dynamic status.

This is because Google APIs do not yet have the capability to retrieve appointment slots. This affects appointment slots created by a user and also slots accepted by someone. Neither type will be read by MiCollab Client. Normal events in the Google calendar will be processed and will be used to reflect MiCollab Client dynamic status.

136

Installation and Configuration

Google contacts integration

MiCollab Client provides users with the option to integrate with Google Contacts.

Licensing

This feature is available by default and no specific MiCollab Client license is necessary.

Authentication and access to Google contacts

To provide the contacts integration feature, MiCollab Client uses OAuth 2.0 to access Google

Contacts.

The process for granting Google Contacts access to applications is described in https://developers.google.com/accounts/docs/OAuth2ForDevices. Below are the sequence of steps that need to be performed by the MiCollab Client administrator. For the latest information, please see the Google URL for OAuth2ForDevices (stated above).Login to Google console.

Note:

Google Contacts only requires the Client ID and Client Secret on the MiCollab Client Service

Manager (using OAuth 2.0 form). Unlike Google Calendar, the authorization code to acquire the

access token of the user’s contacts is done at the client level (not at the server level) as per step 7 .

From a browser, navigate to https://code.google.com/apis/console#access and login using your

Google Apps credentials.

Click APIs from the APIs & auth menu and turn Contacts API to the ON position. This enables

Google Calendar API access.

Click Credentials. Click Create new Client ID under the OAuth section.

Select Installed application as the Application Type. Select Other as the Installed Application

Type. Click Create Client ID.

Google generates a Client ID and Client Secret. These pieces of information are required by

Google to track the number of calendar access requests made on behalf of your Google Apps domain, and to throttle/limit the requests and protect the Google Apps infrastructure from overload.

Copy the Client ID and Client secret.

Click Save and Generate Authorization Code. MiCollab now communicates with Google to obtain consent URI: If the information you entered was incorrect (for example, due to some error in copy-pasting), the MiCollab page will display a brief error message. If this happens, make sure to copy the information from Google console correctly and try again.

MiCollab Clients will need to Configure Google

137

MiCollab Client Administrator Guide

MiCollab Desktop Client clients are now ready to use Google Contacts as part of MiCollab Client.

MiCollab Desktop Clients will need to access PIM Integration window (from Configuration under

Main Menu) and click on “Configure...” drop down button will have a new “Google” item.

Note:

The “Google” item is available whether or not Google calendar integration is enabled on the server.

If there are no other PIMs, the button will not be a drop down, it will just appear as “Configure

Google”.

See MiCollab Desktop Client Help for details on how to Configure Google and Import Contacts.

Once the user selects Google, a Google configuration window will appear and the Google website will automatically be launched. Select Allow access when prompted by Google.

A Google Configuration Window will appear displaying an Access Code, click OK.

If you have multiple Google Accounts, you will be prompted to select one account.

If Google Contacts was successfully configured, you are now ready to Import Contacts to the client.

See MiCollab Desktop Client help to Import Contacts.

138

Chapter 5 Maintenance

MiCollab Client Administrator Guide

About software upgrades

The MiCollab Client Service software includes both the server and client software for MiCollab Client.

MiCollab Client software upgrades may require additional upgrades to the MSL operating system and/or integrated application software.

Before beginning a software upgrade, review the release notes and the Engineering Guidelines for a comprehensive list of upgrade requirements.

Note:

“Client Only Delivery” functionality is applicable to the following clients: MiCollab Desktop Client,

Android, BlackBerry and Web clients. See

“Client only delivery” on page 144 .

MiCollab Client software upgrades

The upgrade to MiCollab Client 7.0 requires an upgrade to the following components:

• MiCollab Client Server v7.0: Includes v7.0 server and client software. The client software must be deployed to each user to complete the upgrade.

• MSL v10.0: Includes the Mitel Standard Linux operating system and Server Manager interface.

Notes:

•

You must be running MiCollab Client Service version 4.0 or higher before attempting to upgrade to MiCollab Client Service version 7.0. If you are running MiCollab Client Service version 3.2 or earlier, first upgrade to MiCollab Client Service version 4.0.

•

MiCollab Client Service version 7.0 requires MSL version 10.0 or later. It will not run on MSL

9.4 or earlier. The upgrade from MSL 9.4 or earlier to MSL 10.0 or later on physical servers requires a backup, reinstall, and restore of the operating system and application data

See the following sections for software upgrades:

•

“Upgrade UC server version 4.0, 4.1, 5.0 or 5.1 to MiCollab Client Service version 7.0” on page 140

•

“Upgrade UC Server version 6.0 to MiCollab Client Service version 7.0” on page 141

•

“Upgrade Virtual MiCollab Client Service (vMiCollab Client)” on page 142

•

“Upgrade the MiCollab Desktop Client” on page 143

•

“Upgrade MiVoice for Skype for Business Client” on page 143

Note:

Upgrades specific to the MiCollab for Mobile for Android, Windows and iPhone clients:

You will be automatically notified of a new version of software available for your clients. Simply follow the on-screen instructions to perform the upgrade.

Upgrade UC server version 4.0, 4.1, 5.0 or 5.1 to MiCollab

Client Service version 7.0

Follow one of the 2 scenarios:

140

Maintenance

Scenario 1: Upgrade UC Server version 4.0, 4.1, 5.0 or 5.1 (physical server) to version 7.0

(physical server) using software downloaded from the AMC

Perform an MSL backup of the MiCollab Client Service.

Download the MSL 10.x CD image from Mitel OnLine and burn it to a recordable CD.

Install MSL 10.x (see “Install the MSL operating system” on page 97 ).

When prompted if a restore operation should be performed, select “Yes”.

Restore from either removable media, or from a network location (see MSL Installation & Administration Guide).

Use the “Blades” panel to install the MiCollab Client Service version 7.0 software.

Scenario 2: Upgrade UC Server version 4.0, 4.1, 5.0 or 5.1 (physical server) to MiCollab

Client Service version 7.0 (physical server) using downloaded CD images

Perform an MSL backup of the MiCollab Client Service.

Download the MSL 10.x CD image from Mitel OnLine and burn it to a recordable CD.

Download the MiCollab Client Service version 7.0 software from Mitel OnLine and burn it to a recordable CD.

Install MSL 10.x (see “Install the MSL operating system” on page 97 ).

When prompted if a restore operation should be performed, select “Yes”.

Restore from either removable media, or from a network location (see MSL Installation & Ad-

ministration Guide).

Insert the recordable CD produced in step 3 above into the CD-ROM tray.

Use the “Blades” panel to install the MiCollab Client Service version 7.0 software.

Upgrade UC Server version 6.0 to MiCollab Client Service version 7.0

Follow one of the 2 scenarios:

Scenario 1: Upgrade UC Server version 6.0 (physical server) to version 7.0 (physical server) using software downloaded from the AMC

Perform an MSL backup of the MiCollab Client Service.

Use the “Blades” panel to install the MiCollab Client Service version 7.0 software.

Scenario 2: Upgrade UC Server version 6.0 (physical server) to version 7.0 (physical server) using downloaded CD images

Perform an MSL backup of the MiCollab Client Service.

Download the MiCollab Client Service version 7.0 software from Mitel OnLine and burn it to a recordable CD.

Insert the recordable CD produced in step 2 above into the CD-ROM tray.

Use the “Blades” panel to install the MiCollab Client Service version 7.0 software.

141

MiCollab Client Administrator Guide

Upgrade Virtual MiCollab Client Service (vMiCollab Client)

See the Virtual Appliance Deployment Solutions Guide for detailed information about upgrade paths.

Note:

After the upgrade is complete and verified, you must remove any snapshots. Removing the snapshots ensures performance for voice-intensive Mitel virtual applications.

Backup your existing MiCollab Client virtual appliance. Select Backup. Select a location to place the backup file. Click Perform.

Copy your vMiCollab Client database backup file to a USB device or a shared directory on the network file server. Note that back up to a USB device is available only with vSphere 4.1 and later.

Shut down the existing MiCollab Client Service, using the MSL Shutdown or reconfigure option.

Download the new virtual appliance file (.ova) from Mitel OnLine and save it on your local machine.

Start the vSphere Client, and then select File – Deploy OVF Template….

Select Deploy from file and then browse to the location on your machine where you saved the new .ova file.

Click Next. The OVF Template Details page appears.

Click Next. The End User License Agreement page appears.

Click Accept, and then click Next. The Name and Location page appears.

10. Type a name for virtual server, and then click Next. Deployment settings for the virtual appliance are shown.

11. Confirm the settings, and then click Finish to deploy the file. A dialog box shows the progress of the files being deployed.

12. When the deployment completes successfully click Close to continue.

13. In the vSphere client window, expand the VMware host view to show the newly created virtual machine.

14. Click the Console tab. Click the green arrow to power on the virtual machine.

15. After the virtual machine has booted, the Console Tab shows the MSL installation window.

16. Choose your preferred keyboard from the list (the default is us) and click Next.

17. MSL prompts you by asking if you want to restore from backup. Enter Yes.

18. Select Restore from USB and insert your USB key when prompted OR Select Restore from

Network Server (depending on where you placed your backup at the beginning of this procedure). Follow the prompts to specify the location of the backup file and start the restore process.

142

Maintenance

Upgrade the MiCollab Desktop Client

When you upgrade the MiCollab Client Service software blade, a MiCollab Desktop Client installer is included in the software blade and the MiCollab Client Service property file is updated with the latest software version information.

Note:

The MiCollab Desktop Client requires the installation of the Microsoft.NET Framework v4.0 or v4.5

(see

“Microsoft .NET framework” on page 111 ) prior to installing the MiCollab Desktop Client.

Upgrades from v6.x

After you upgrade the MiCollab Client Service to v7.x, the 6.x MiCollab Desktop Client polls the

MiCollab Client Service property file and determines that a client installer is available.

The MiCollab Desktop Client notifies the user that the 7.x software is available as follows:

• If the user is logged off the MiCollab Desktop Client when the upgrade becomes available, the

Upgrade Product notification dialog box appears when he or she attempts to log in.

The user can click Upgrade to start the upgrade process. If the user clicks Cancel, the MiCollab

Client version popup window appears after the user logs in.

• If the user is logged in to the MiCollab Desktop Client when the upgrade becomes available, the

MiCollab Client version popup window appears

The user can click Upgrade to start the upgrade process. If the user clicks Remind me later, this popup window reappears each following day until the user upgrades to the latest version.

Users should close all Windows applications before initiating the upgrade.

After the client upgrade process is initiated, the software is downloaded to the user’s computer.

When the download is complete, the installation wizard appears prompting the user to install. The user can then run the installation wizard (see

“Installation procedure” on page 111 ) to install the

upgraded client. When completing upgrades, the Installation wizard auto-populates the MiCollab

Client Service FQDN and Default Language fields based on the previous software version’s settings.

Following an upgrade, the MiCollab Desktop Client restarts automatically and the following client components are migrated to the upgrade version:

• User-specific configuration settings

• Detailed call history

• Personal contacts

Upgrade MiVoice for Skype for Business Client

The administrator informs the user(s) of a new MiVoice for Skype for Business software version being available with a link (URL) to download the new .msi file.

Before executing manually, the user has to explicitly close Skype for Business and then upgrade the MiVoice for Skype for Business. To perform the upgrade, the user must have installation

143

MiCollab Client Administrator Guide

permissions on the computer or provide the administrator credentials when prompted. It is not required to uninstall the previous software version prior to performing an upgrade.

Once the upgrade is complete, the MiVoice for Skype for Business and Skype for Business client will be restarted. The existing settings will be preserved throughout an upgrade.

Client only delivery

Client Only Delivery functionality delivers Windows MiCollab Desktop Client without having to upgrade the MiCollab Client Service version.

The Client Versions section in MiCollab Client Service Administration section allows for the administration of these upgrades.

Using the Administration web interface you will be able to install, upgrade, or downgrade selected components of the MiCollab Client Service blade by specifying a local client package and clicking the “Upload MiCollab Client” link.

An “Operation status report” displays either a successful client software package installation or an error message indicating a validation step has failed. Several validation steps are performed to prevent user from:

• uploading files that are not valid client packages

• replacing a system or MiCollab Client Service level component

• uploading a corrupted client file

Note:

There is no ability or mechanism to remove any individual MiCollab Client software clients.

User upgrades (stand-alone to integrated)

MiCollab Client provides two options for users: Integrated and Stand-alone:

• Integrated MiCollab Client users: Users who are licensed for the Desk Phone or Softphone features and not the Stand-alone Web Portal feature have access to the integrated suite of

MiCollab Client interfaces including the MiCollab Desktop Client, Web Portal, and Mobile Portal.

• Stand-alone MiCollab Client users: Users who are licensed for the Stand-alone Web Portal and not the Desk Phone or Softphone features can access MiCollab Client features from the corresponding portal only. They do not have access to the MiCollab Desktop Client application.

MiCollab Client provides an upgrade process to upgrade stand-alone users to integrated.

To upgrade Stand-alone Web Portal users to Integrated:

Purchase the desired number of Desk Phone and/or Softphone licenses from the AMC. A Desk

Phone or Softphone license is required for integrated users (see

Table 2 on page 22

From the MSL Server Manager interface, synchronize the MiCollab Client Service with the AMC to verify that the server has the appropriate licenses for each user (see

“Verify MiCollab Client

Service licensing” on page 100 ).

From the MiCollab Client Service Administrator interface, complete the following tasks:

144

Maintenance

• Do one of the following to apply the Desk Phone or Softphone license to the users you want to upgrade (Accounts Tab – <user> – Account Details page – Licensed Features):

For each user, select a feature profile that includes the Desk Phone or Softphone licensed features.

Note:

If required, configure a feature profile that includes the Desk Phone and/or Softphone licensed features (Features Tab – Add Profile).

For each user, select the Desk Phone or Softphone Add-On feature.

• If other account -specific changes are required, reconfigure those fields and options on the

Account Details page for each user.

• Resend the Welcome e-mail message to each upgraded user.

Note:

See the Online Help for information about the following topics:

•

Stand-alone vs. integrated user settings

•

Feature profiles

•

Welcome E-mail message

Do one of the following:

• Instruct the user to install the MiCollab Desktop Client using the client software URL provided in the Welcome E-mail message.

• Install the MiCollab Desktop Client on the user's PC (see

“Install the MiCollab Desktop Client” on page 109 ).

145

MiCollab Client Administrator Guide

MSL Server Administration

The MSL Server Manager provides menus for performing MSL-related administrative tasks.

These tasks are not related to MiCollab Client administrator tasks (see

“MiCollab Client Service

Administration” on page 146

). However, they may be helpful for MiCollab Client Service

diagnostic purposes such as gathering log files (see “Server log files” on page 167

For information about MSL administrator tasks, see the MSL Server Manager online help or the MSL Installation and Administration Guide available on the Mitel eDocs Web site

(http://edocs.mitel.com) for details and instructions.

MiCollab Client Service Administration

The main MiCollab Client Service Administration page provides access to several options.

Configuration

Status

The Configuration section of the page provides access to the MiCollab Client Service

Configuration tabs where you can provision the system (see

“Provision MiCollab Client” on page 107 ). Click Configure Mitel MiCollab Client Service. The configuration pages open to

the Enterprise tab. See the online Help for tab-specific information and instructions.

The Status section of the Mitel MiCollab Client Service Administration page provides the name and current status for the MiCollab Client Service. Statuses include:

• Active: The server is online and operational.

• Becoming Active: The server is in the process of coming online.

• Idle: The server is offline and not operational.

To start, stop, or refresh the server:

Select an action from the list box. Options include:

• Start Mitel MiCollab Client Service

• Stop Mitel MiCollab Client Service

• Refresh Status

Click Perform Requested Action.

Note:

If the MiCollab Client Service is stopped using the “Stop Mitel MiCollab Client Service” selection, then the MiCollab Client Service will remain stopped until it is explicitly started using the “Start Mitel MiCollab Client Service” selection, even across system reboot operations.

146

Maintenance

Diagnostics

The Diagnostics section of the page provides access to diagnostics tools. Click Perform Server

Diagnostics to access diagnostics tools.

Note:

Do not use the Mitel MiCollab Client Service Diagnostic tools unless you are instructed to do so by Mitel technical support personnel.

The tabs on the Mitel MiCollab Client Service Diagnostics page include:

• Modules: Displays the following information for all of the modules running on the system:

• Name: Displays the name of the module running.

• Uptime: Displays how long the module has been running for.

• Restarts: Displays how many times the module has been stopped and restarted. This helps you determine if a module stopped unexpectedly. If a module was not restarted manually and the module indicates it has been restarted, this indicates an error condition.

• Status: Displays the state of a module. IN_SERVICE indicates a module is operating correctly. Many modules have custom strings like READY_FOR_CALL, etc. A module shows

SHUTDOWN if it is turned off by clicking Stop. Unwatched modules show UNKNOWN (not watched), because they are not monitored by a watchdog component. A monitored module should not display UNKNOWN.

• Status Operations: Modules that are monitored by a watchdog component can be started, stopped, or restarted from here. You may need to refresh the view by clicking the Modules tab.

• Debug Level: Indicates the debug level at which the module is currently running. The debug level for a module can be anywhere between 1 and 5. The higher the debug level, the more information that is generated by the module and printed in the associated logs.

• Set Debug Level: Configure the debug level for a module here by selecting the level from the list and then clicking Set. After the page is refreshed, the Debug Level reflects the level you configured.

•

Clients: Provides information about currently connected clients in the system. The first line of the page indicates the number of connected clients on the system. You can search for a specific

Login ID, or for a specific client type by modifying the appropriate form fields provided and then clicking the Search button. If no values are supplied on the search form, pressing the Search button will display a listing of all connected clients. The following information is displayed for each client:

• Bridge ID

• Login ID

• Client Info (the type of client that the user is using)

• Connection (the IP address of the connecting client)

• Connected Since (the time that the client connected).

• Registrations: Provides information about currently registered phones in the system. The first line of the page indicates the number of registered phones on the system. By default, no phone is selected. You can search for a specific phone by selecting a Tenant from the list, typing the

147

MiCollab Client Administrator Guide

Login ID for the user, and then clicking Search. You can also search for all registered phones by typing the % character in the Login ID field. The following information is displayed for each user:

• Tenant ID

• Alias ID (an alternate name for the user on the server)

• Address ID (usually the user’s public number)

• Expiration Date (the time when the user’s registration expires)

• Device ID (the type of device/and MiCollab Desktop Client version that the user is using)

• User Agent (additional information about the user’s MiCollab Desktop Client)

• Resource ID (the registered SIP address where the server sends SIP requests)

• TDC: Indicates information about the following modules on the system:

• ACCTPRES, IM EVENTS, PRES, SIP PROXY, SIP REG: These modules show SIP statistics and include the following information:

The tabs show Incoming and Outgoing SIP requests and responses.

The request columns are further divided into Register, Subscribe and Notify which are types of SIP messages.

The Responses are broken down into 1xx, 2xx, 3xx, 4xx, 5xx, 6xx and unknown columns. 2xx responses are success messages, while unknown, 1xx, 3xx, 4xx, 5xx, and

6xx responses are error responses.

The Errors column reports any anomalies for the module.

• CALL SERVICES: This area indicates the feature usage for the server. Hourly values for each day for Place call, Answer, Hangup, Hold, Retrieve, Deflect, Transfer and Conference are reported.

• VISUAL VOICEMAIL: This page shows the session success and error codes for the Visual

Voice Mail feature provided by the Web services. Hourly statistics for VM Session Success,

VM Session Fail, Make Call, Forward Message, Delete Message, Set VM Pin and Send

Fax are shown.

You can view logs for each day by selecting a day from the list.

• Subscriptions: Indicates the subscription events in use by the system. The information is shown in the tabular format with the first column indicating the Event ID and the next column showing the number of each subscription events in use. You can view detailed information for each subscription by selecting a Tenant from the list, typing the Login ID for the user, and then clicking

Search. You can also search all subscriptions by typing the % character in the Login ID field.

The following information is displayed for each user:

• Subscription ID

• EVENT_ID (which event the user is subscribing to)

• WATCHER_ID (the user subscribing to the event)

• WATCHED_USER

• EXPIRES (the time when the user’s subscription expires)

• ROUTE_SET (the route that future SIP NOTIFYs from the server should take to reach the client)

148

Maintenance

• Calstatus: Provides a set of diagnostic functions that can be used for troubleshooting. Although some of the diagnostic information is valid for all types of Calendar Integration, the Calstatus diagnostics are geared towards Microsoft Exchange, Office 365 and Google Calendar

Integration.

Note:

Some operations with Calstatus diagnostics can cause issues with Calendar and Google,

Office 365, or Exchange Integration. Use caution when reviewing Calstatus values and work in conjunction with your Google, Office 365, or Exchange server administrator and Mitel

Technical Support if necessary when handling problems.

The following is a description of the information that can be accessed through these diagnostics:

• Enterprises and Advanced Configuration: This page under the Calstatus diagnostics tab lists all the enterprises available on the MiCollab Client Service.

Enterprise Details: If any of the enterprises have either a Google, Office 365, or

Exchange Server configured and enabled for Calendar Integration, those are listed under the Calendar Integration column. If Google, Office 365 and Exchange Integration is disabled for an enterprise, then the Details link is not displayed. Clicking on the Details link displays the Calendar Integration details for that enterprise.

Advanced Configuration: Below the list of enterprises, the page shows Advanced

Configuration for the Calendar Integration. For more information about these fields, changing them, and the effects of such changes, see the MiCollab Client Administrator

Online Help system.

List of recent OAuth 2.0 Data Updates is also displayed on this page.

• Enterprise Details: This page shows the detailed Google, Office 365, or Exchange Integration configuration information for a specific enterprise.

Enterprise Name: MiCollab Client enterprise name

Calendar Integration Type: Google, Office 365 or MS Exchange

Enterprise’s calendar integration active?: Indicates whether or not the Google, Office

365, or Exchange Integration is active and enabled for this enterprise. If there are any permanent errors associated with this calendar integration, this flag shows “No”. If error details are available, those details are shown at the bottom of the page.

Is Temporarily Disabled?: Indicates whether communication with Google, Office 365, or Exchange server has been temporarily disabled. If details are available, they are shown below this flag, along with a time stamp of when the communication will be retried. For this retry to happen, no action needs to be taken by the Administrator.

MiCollab Client will continue to retry until the error is resolved.

Exchange Access URL: The Exchange Web Services (EWS) URL on the Exchange server. MiCollab Client retrieves user calendar information from this URL.

Exchange Impersonation Enabled?: Indicates whether or not MiCollab Client

Exchange integration is configured to use impersonation.

Exchange Server Access Username: Displays the Exchange username that is used to retrieve calendar information.

Exchange Access Credentials Valid?: Indicates whether or not the Exchange access username and password are valid.

Exchange Version: Displays the Exchange server version.

Subscription URL: Displays the Subscription URL (applicable to Exchange Integration

149

MiCollab Client Administrator Guide

only).

Users List: The lists displayed are categorized according to users’ status and are based on error conditions, if any exist:

Number of Valid Users: Lists users who have Google or Exchange Integration configured. If a user has another type of Calendar Integration configured (such as

Outlook or Lotus Notes), then that user does not show up in this list.

Active Users: Lists a subset of valid users and contains only those users whose

Google, Office 365, or Exchange Integration is active. Users who have configured either

Google, Office 365, or Exchange Integration but have disabled it or those who have been deactivated because of errors do not show up in this list.

Deactivated: various errors: see list below.

Deactivated: temporarily disabled.

Deactivated due to impersonation error: If impersonation is not configured correctly on the Exchange server, Exchange Integration can be deactivated for the affected users. Once impersonation is configured correctly, you can click on “Reactivate Users” to reactivate Exchange Integration for the affected users.

The other lists pertain to various error conditions.

• User Lists: Select a user from the list or enter the user’s MiCollab Client login ID and click

Show User Details. This takes you to either the user’s Google, Office 365, or Exchange

Integration details page.

• User Details: This page displays details about the user’s Google, Office 365, or Exchange

Integration configuration and status. Most of the settings shown here are configured by the user from a MiCollab Client.

Calendar Type: Indicates the type of Calendar Integration chosen by the user. This can be Google, Office 365, MS Exchange, Outlook, or Lotus Notes based on the configuration. Most of the information on the User Details page is grayed out unless the

Integration is with Google, Office 365, or Exchange, because the remaining types (such as Outlook/Notes) are managed by MiCollab Clients, and not by MiCollab Client

Service.

MiCollab Client User ID: Displays the user’s MiCollab Client Enterprise ID and user ID.

• User’s Calserver Credentials Valid: Indicates whether or not the user’s credentials are valid.

User’s Calendar integration Valid: Indicates whether or not the user has configured

Calendar Integration.

CalServer Primary e-mail Address: Displays the user’s Exchange primary e-mail address.

• CalServer Username (specific to Exchange Integration): Shows the user’s Exchange username. The “Dissociate Credentials” option clears out the user’s Exchange credentials that are cached on the MiCollab Client Service and immediately disables the user’s

Exchange Integration.

Use with caution.

• Google Calendar ID: Shows the user’s Google Calendar ID. The “Dissociate Credentials” option clears out the user’s Google credentials that are cached on the MiCollab

Client Service and immediately disables the user’s Google Integration.

Use with caution.

User’s Calendar integration Active: Indicates whether or not the user’s Calendar

150

Maintenance

Integration is active. A user’s Calendar Integration could be inactive if the user has disabled Calendar Integration or as a result of other errors, usually with user configuration. Therefore these errors are specific to that user and do not affect Calendar

Integration for the entire enterprise. If errors details are available, they are displayed in this field, as shown in the examples below. In the first example, a user has disabled

Calendar Integration from the client. In the second example, the Exchange server has returned an error that the Exchange e-mail address entered by the user has no mailbox associated with it (this is most likely a result of entering the e-mail address incorrectly).

Even if user’s calendar integration settings are all correct, there could be other problems

(such as network connectivity issues, or incorrect calendar integration settings at the

Enterprise level. In such cases, calendar integration will be disabled for that entire enterprise. Such problems are not specific to a user. However, to indicate the presence of a problem, those problems are also shown in the user details page.

In the example shown below, the communication with Exchange server has been temporarily disabled. The error details indicate that the MiCollab Client Administrator can act on it. Since this is not a user-specific error, the user cannot do much apart from notifying the Administrator of the error. Not correcting the error but trying to reactivate this user alone will not help, because the user will encounter the same error once again and will get disabled.

151

MiCollab Client Administrator Guide

152

After correcting the error conditions, you can click on “Reactivate User” to have MiCollab

Client reinitiate the user’s Calendar Integration. If the error condition persists or another error is displayed, the user is deactivated again.

Note:

In most cases, user reactivation should be done by the user correcting the incorrect configuration parameters, NOT by administrative action. The “Reactivate User” button is provided as an additional mechanism for you to troubleshoot problems.

Calendar Integration Enabled?: Indicates whether the user has enabled/disabled

Calendar Integration from the client.

Advisory Message Enabled?: Indicates whether the user has enabled/disabled Calendar

Advisory. If advisory is disabled, Calendar Integration continues to work, but MiCollab

Clients do not display advisory messages such as “In a meeting until 11:30 AM”.

Status Transition Settings: Lists the MiCollab Client status transitions configured by the user. These MiCollab Client status transitions are triggered based on the user’s calendar status.

Calendar Event Subscription: The MiCollab Client Service subscribes to event notifications with the Exchange or Office 365 server. If a user’s calendar is updated, then the Exchange or Office 365 server notifies the MiCollab Client Service of this update through the subscription mechanism. The times at which the last few subscriptions occurred, the times at which the Exchange or Office 365 server sent the notifications, and so on can be helpful in troubleshooting problems. The MiCollab Client Service initiates subscriptions based on the configured interval (see Advanced Settings in the MiCollab

Client Administrator Online Help). Clicking on “Force Resubscription” causes the MiCollab

Client Service to immediately try to initiate a subscription for this user.

Calendar Event Polling: The MiCollab Client Service periodically polls the Google,

Exchange or Office 365 server to fetch users’ calendar information. The times at which the polling occurred and the next scheduled poll time can be useful in troubleshooting problems. The “Force Event Poll Now” button causes the MiCollab Client Service to immediately initiate an event poll for this user.

Last few MiCollab Client status changes triggered by calendar availability: This is a list of the last few MiCollab Client dynamic status changes caused by either Google,

Exchange or Office 365 Integration. If the MiCollab Client dynamic status changes for any reason other than Google, Exchange or Office 365 Integration, that change is not shown here. For each status change, the time of change, the previous status, the next status, calendar advisory (if any), and status names and IDs are displayed.

• Integrated Directory Services (IDS) Auth Cache: When MiCollab Client is operating in MiCollab integrated mode, the administrator can setup Integrated Directory Services (MiCollab IDS)

Maintenance

to authenticate MiCollab Client users. In that configuration, IDS will authenticate MiCollab Client users’ login passwords with a configured LDAP server (in most deployments, an Active Directory server). The password can change on the ActiveDir server (for example, due to a password expiry policy). When this happens, MiCollab Client users should not be allowed to login with their old passwords, for the sake of security. To accomplish this, MiCollab Client Service periodically validates passwords with IDS (which in turn validates it with the ActiveDir).

In most cases there is no special configuration needed to use this feature. However, there are some parameters which can be tweaked if necessary. They are described in the following sections.

When MiCollab Client detects that the password has changed on ActiveDir and the password previously entered by the MiCollab Client user is no longer valid, the user will be logged out of the MiCollab Clients (if they are logged in at that time). The user will have to re-login with the new password.

• How to enable MiCollab Client IDS Password monitoring: The administrator does not need to do anything explicit to enable this. When MiCollab Client is operating in MiCollab-integrated mode, the monitoring will turn itself on.

•

Server Status:

• Server Mode: This field indicates whether MiCollab Client is operating in MiCollab-Colocated or MiCollab-Integrated mode. The password monitoring is disabled in Co-located mode, and only works in integrated mode.

• Number of Subscribers being monitored: Indicates how many MiCollab Client users’ passwords are being monitored. All the users on the MiCollab Client system may not be monitored. Specifically, if a MiCollab Client user has never logged in through a MiCollab

Client, that user will not be monitored. Once the user logs in for the first time, monitoring will start for that user.

• State of server: Indicates whether the password monitoring is initializing or is fully up and running.

• Last password validation occurred at: Shows the timestamp of the last validation.

This does not necessarily mean that the password was valid, but it is only the time when the validation attempt was made.

• Configuration Parameter: In most cases these parameters do not need to be changed and the default values work fine.

• Subscriber Load Retry Delay: During the initialization phase of the password monitoring, if there are any errors in loading the subscribers, server will wait for some time and retry. This parameter controls the duration of that wait.

• MiCollab Mode Retry Delay: MiCollab Client Service checks periodically whether it is in integrated mode or not. This parameter controls how often MiCollab Client checks for the mode. The monitoring only starts when MiCollab Client is in integrated mode.

• Poll Loop Delay: When in integrated mode, MiCollab Client Service periodically checks whether any subscriber is eligible for password monitoring right now. This parameter controls how often that check is made.

• Password Validation Interval: When in integrated mode, MiCollab Client Service periodically validates each user’s password.This parameter controls how often each user’s password is validated. By default the parameter is set to 6 hours. That means once a user’s password is changed in ActiveDir, within 6 hours (3 hours on average because the users are uniformly distributed in that time interval) the MiCollab Client will detect it

153

MiCollab Client Administrator Guide

and notify the user. The minimum parameter value is 4 hours (this is to prevent overloading the IDS and ActiveDir server with frequent requests) and maximum is 24 hours.

• Last few Errors: This section shows some errors that occurred in the past. Invalid user password is not an error condition. Errors are listed if there are any problems contacting the

ActiveDir server and other such issues.

When errors like this occur, the MiCollab Client user’s password is not immediately invalidated. MiCollab Client Service will periodically keep retrying until it can successfully contact the ActiveDir server determine whether the password is correct or not.

• User Details: This section shows the password monitoring details for a particular user. For troubleshooting, you can force the MiCollab Client Service to immediately re-validate a user’s password. To do this, enter the loginID and click “Validate User’s password now”. It can take about 10-30 seconds for ActiveDir to respond. After that time, click on “Show User

Details” again to check whether user’s password was valid or not. Once the user’s password is determined to be incorrect, all the logged in MiCollab Clients for that user will be logged out. User will need to enter the new password and log back in.

MiCollab Client Service Chat maintenance

This section describes how to disable chat storage on the MiCollab Client Service and how to remove existing chat history from the server.

Disable chat storage on server

Use the following commands to disable the MiCollab Client Service from storing chat history.

Note:

It may be helpful to copy the command to the clipboard and then paste the command into PuTTY.

edit /etc/e-smith/templates/opt/intertel/conf/sip_ims.ini/50Configuration set EnableFile=no

expand-template /opt/intertel/conf/sip_ims.ini

Delete existing chat history from server

Use the following procedure to delete existing chat history from MiCollab Client Service.

Stop the SIPIMS service from the MiCollab Client Service diagnostic page.

Go to the MiCollab Client Service configuration page and click the Perform Server

Diagnostics under Diagnostics.

Locate SIPIMS and click Stop.

Move all files from the /opt/intertel/data/imarchive directory.

You may want to move the files to /root by performing 'mv hab_ims_archive* /root' from the

/opt/intertel/data/imarchive directory. You can do this with PuTTY, but if there are many files, you may want to use an application such as WinSCP.

You can also delete the files from the PuTTY command line if you do not want to keep the history.

154

Maintenance

Restart MiCollab Client Service.

MiCollab Desktop Client maintenance

This section describes how to install custom options, repair an installation, and uninstall the MiCollab

Desktop Client.

Install custom options

During a typical installation of MiCollab Client, the installer detects the PIMs that are installed on the user's computer and installs the associated extensions by default. However, in the case where a custom installation was performed and an extension was not installed, or in the case where a PIM was installed after MiCollab Client was installed, MiCollab Client prompts the user to install the PIM extension on startup. Users can install PIM extensions and other custom options using the Custom

Install option available in the installation wizard.

Custom options include:

• ACT! Integration: Includes the ACT! PIM extension, which provides contact integration between

ACT! and MiCollab Client.

• Dial from IE: Allows users to dial an external number from Internet Explorer using MiCollab

Client.

• Lotus Notes Integration: Includes the Lotus Notes PIM extension, which provides contact integration between Lotus Notes and MiCollab Client and provides dialing from Lotus Notes.

• Outlook Extensions: Includes the Outlook PIM extension, which provides contact integration between Outlook and MiCollab Client and provides dialing from Outlook.

• MiCollab Client Office Smart Tag: Adds Smart Tags/Actions to Microsoft Office Applications, allowing users to dial external numbers from the applications using MiCollab Client. Users must complete additional configuration in the application to enable Smart Tags/Actions.

• MiCollab Client SDK: The Software Development Kit (SDK) includes additional software and tools to integrate third-party applications with MiCollab Client. This component is used strictly by Software Developers and typical MiCollab Client users should not install it.

Note:

The MiCollab Client SDK is supported by the

Mitel Solutions Alliance (MSA) Developers and

Integrators Program

(http://www.mitel.com/DocController?documentId=9971).

For MiCollab Client SDK technical support (requires Technical Support ID), contact the MSA program at [email protected] or one of the following numbers:

•

North America: 1-800-267-6244 (8 a.m. to 5 p.m. Monday to Friday, EST)

•

EMEA / AP: +44 (0) 1291 436888 (8 a.m. to 6 p.m. Monday to Friday GMT)

To install custom options for the MiCollab Desktop Client:

Exit the MiCollab Desktop Client.

Close the user's PIM application, Internet Explorer, and all Microsoft Office applications.

For Vista/Windows 7: Select Start – Control Panel – Programs and Features.

155

MiCollab Client Administrator Guide

Highlight Mitel MiCollab Client in the list of programs.

Click Change. The MiCollab Client Installation Wizard Welcome screen appears.

Click Next. The Change, Repair, and Remove options are displayed.

Click Change. The Custom Setup screen appears. A red

indicates that a component is currently not installed.

Do the following for each component you want to install:

• Click the down arrow next to the uninstalled component.

• Select Will be installed on local hard drive.

Click Next. The MiCollab Client Configuration dialog box appears.

10. Verify that the Fully Qualified Domain Name field is accurate. The FQDN is provided in the

Welcome E-mail message (see page 110).

11. Select a Default Language, and then click Next. The Ready to change dialog box appears.

12. Click Change to begin the installation. The components you selected are installed.

13. Click Finish to complete the installation process.

14. Do one of the following at the restart prompt:

• Click Yes to automatically restart your computer now.

• Click No if you want to restart your computer later.

Repair the MiCollab Desktop Client

If the client installation becomes corrupt, a repair is required. Although this event is unlikely, it can occur if the user inadvertently deletes one or more application files.

In addition, if you have contacted Mitel Technical Support regarding a problem, the support associate may request that you run a repair to ensure that the installation is valid before proceeding to diagnose an issue.

To repair the MiCollab Desktop Client installation:

Exit the MiCollab Desktop Client.

Close the user's PIM application, Internet Explorer, and all Microsoft Office applications.

For Vista/Windows 7: Select Start – Control Panel – Programs and Features.

Highlight Mitel MiCollab Client in the list of programs.

Click Change. The MiCollab Client Installation Wizard Welcome screen appears.

Click Next. The Change, Repair, and Remove options are displayed.

Click Repair. The Repair screen appears.

Click Repair. MiCollab Client repairs the installation.

156

Maintenance

Click Finish to complete the installation process.

Uninstall the MiCollab Desktop Client

Although users can safely upgrade by installing the latest MiCollab Client version, they may prefer to uninstall the previous version before installing the latest version.

To uninstall the MiCollab Desktop Client, remove the application using the Windows Add or Remove

Programs function.

User-specific files including configuration files, log files, license files, and databases, are not removed. To remove the older data, settings, and logs, rename or delete the following folders:

• Windows Vista/Windows 7/Windows 8

• C:\Users\username\AppData\Roaming\Mitel\MiCollab Client

• C:\Users\username\AppData\Local\Mitel\MiCollab Client

Note:

The “Application Data” or “AppData” folders may be hidden by default in the system. To view these folders, click on ‘Show hidden files and folders’ from the Folder View Options menu in

Windows.

157

MiCollab Client Administrator Guide

PBX configuration changes

This information applies to sites that have configured a PBX Node Synchronizer in the MiCollab

Client Administrator Interface to create MiCollab Client accounts.

After you complete phone extension configuration changes (add, delete, move, change) on the PBX, perform a manual synchronization (click the Sync Now button on the Synchronization tab in the

MiCollab Client Service Administrator interface) to immediately update the affected MiCollab Client accounts. If you do not perform a manual synchronization, the affected MiCollab Client accounts will be updated at the next scheduled synchronization.

In addition, for those MiCollab Client users whose extensions are affected by the configuration changes you make on the PBX, instruct the users to exit and then restart their MiCollab Desktop

Clients to refresh extension information.

158

Chapter 6 Troubleshooting

MiCollab Client Administrator Guide

Server troubleshooting

This section provides troubleshooting information for the MiCollab Client Service.

Installation problems

Table 21 MiCollab Client installation problems provides troubleshooting information for server

installation problems.

Table 21: MiCollab Client installation problems

Problem or Error Probable Cause Corrective Action

The MSL server is showing the

Service Temporarily Unavailable or Bad Gateway message when you are trying to install the MiCollab

Client Service.

This can occur if the status page is refreshed (reloaded) automatically at the same time that the Web server is restarted.

To clear the message, click the

Blades link under ServiceLink.

Wait a couple of minutes and then try the request again.

The MSL server is showing the

Service Temporarily Unavailable

message when you are trying to provision the MiCollab Client

Service.

This may occur if the JBoss application server is starting at the same time that the configuration page is loaded (for example, if you click Configure Mitel MiCollab

Client Service immediately after the MiCollab Client Service is configured or started).

Server synchronization error messages

This section provides error messages for the following situations:

•

MiCollab Client Service synchronization messages below

•

“AD/LDAP synchronization error messages” on page 161

•

“PBX node synchronization error messages” on page 162

•

“Collaboration server synchronization message” on page 163

160

Troubleshooting

MiCollab Client Service synchronization messages

Table 22 MiCollab Client Service synchronization error messages lists the MiCollab Client Service

error messages that may appear in the MiCollab Client Service Administration interface during the synchronization process.

Table 22: MiCollab Client Service synchronization error messages

Error Message

System Busy.

Probable Cause Corrective Action

System is in maintenance mode, or system in start up mode.

Wait until system is in service mode or wait until system is fully started.

Purchase additional license.

License exceeded.

Exceeded customer purchased license feature.

Too many primary aliases exists.

Too many aliases exists.

Remove user/account alias.

Invalid alias ID.

Invalid voice mail system.

Authentication failed.

Password too short.

Alias ID is invalid.

The provisioned VM is invalid.

Invalid user name or password.

User’s password is too short.

Validate user/account alias.

Provision a valid VM system.

Try user's valid user name and password.

Change to a longer password.

AD/LDAP synchronization error messages

Table 23 AD/LDAP synchronization error messages lists the AD/LDAP synchronization errors that

may appear in the MiCollab Client Service Administration interface when you complete this type of synchronization. The actual error message may vary depending on the LDAP server. Use the error messages below as guidelines.

Table 23: AD/LDAP synchronization error messages

Error Message

Error establishing LDAP Context for url ldap://<ldap server IP>:<ldap

port>.

Probable Cause

Invalid LDAP URL (Wrong IP/Port, etc.).

[LDAP: error code 32 - 0000208D:

NameErr: DSID-031001CD, problem 2001 (NO_OBJECT), data

0, best match of:

'OU=EPMTest,DC=pvuc,DC=inter-t el,DC=com'].

Invalid LDAP search context.

Invalid User query - The error message varies based on the actual error in the user query.

LDAP user query is wrong.

Corrective Action

From the MiCollab Client Service administrator interface, set the correct LDAP url and try the synchronization again.

From the MiCollab Client Service administrator interface, either remove the search context or set the correct search context and try again.

From the MiCollab Client Service administrator interface, either remove the user query or correct the user query and try the synchronization again.

Page 1 of 2

161

MiCollab Client Administrator Guide

Table 23: AD/LDAP synchronization error messages (continued)

Error Message

Error establishing LDAP Context for url ldap://<ldap server IP>:<ldap

port>: [LDAP: error code 49 -

80090308: LdapErr:

DSID-0C090334, comment:

AcceptSecurityContext error, data

525, vece].

Probable Cause

Invalid username/password.

Corrective Action

From the MiCollab Client Service administrator interface, set the correct username/password and try the synchronization again.

[LDAP: error code 12 - Unavailable

Critical Extension]

The LDAP server does not support paged results and the Server

supports paging results option is selected on the Synchronizer

Details page in the MiCollab Client

Service Administrator interface.

Deselect the Server supports

paging results flag on the

Synchronizer Details page, save the change, and try the synchronization again.

Page 2 of 2

Note:

See

“AD/LDAP synchronization log file” on page 169 for more information about the AD/LDAP

Synchronization log file.

PBX node synchronization error messages

Table 24 PBX Node synchronization error messages lists the PBX node synchronization errors that

may appear in the MiCollab Client Service Administration interface when you complete this type of synchronization.

Table 24: PBX Node synchronization error messages

Error Message Probable Cause Corrective Action

AuthData Sign failed.

Authenticate request failed.

Search next failed with invalid number of fields.

MiCollab Client Service security certificate is invalid.

Authentication error. Verify that the MiCollab Client

Service is compatible with MiVoice

Business.

Upgrade MiVoice Business and the

MiCollab Client Service to compatible versions.

Invalid number of fields. NTuples failed.

MiVoice Business and the MiCollab

Client Service versions are incompatible.

Upgrade MiVoice Business and the

MiCollab Client Service to compatible versions.

Search first failed with invalid number of fields.

Verify that the MiCollab Client

Service is compatible with MiVoice

Business.

Verify that the MiCollab Client

Service is compatible with MiVoice

Business.

MiVoice Business became non-operational during sync.

Upgrade MiVoice Business and the

MiCollab Client Service to compatible versions.

Upgrade MiVoice Business and the

MiCollab Client Service to compatible versions.

Upgrade MiVoice Business and the

MiCollab Client Service to compatible versions.

Retry sync after 5 minutes.

Page 1 of 2

162

Troubleshooting

Table 24: PBX Node synchronization error messages (continued)

Error Message

Search NextTuples failed.

Search NTuples failed.

Probable Cause

MiVoice Business became non-operational during sync.

Server returned Error.

NextNTuples failed.

Server returned Error. NTuples failed.

Server returned failure.

MiVoice Business became non-operational during sync.

View the EPM logs to determine error code.

Soap client context setup error.

Internal MiCollab Client Service error.

Soap login failed.

Node IP/Password is incorrect.

Corrective Action

Retry sync after 5 minutes.

Corrective action based on the error code.

Restart the MiCollab Client Service.

Soap login rejected.

Version request failed.

Node IP/Password is incorrect.

The MiCollab Client Service is not compatible with MiVoice Business version.

Set the correct IP/Password for the node and sync again.

Upgrade MiVoice Business and the

MiCollab Client Service to compatible versions.

Version fetch failed.

DSM internal error.

Node not found.

INVALID Password.

Node connection terminated.

Connection not established.

The MiCollab Client Service is not compatible with MiVoice Business version.

MiCollab Client Service internal error.

The MiCollab Client Service is not connected to 5k PBX.

The MiCollab Client Service connection to 5k got lost during sync.

The MiCollab Client Service connection to 5k is not valid.

Upgrade MiVoice Business and the

MiCollab Client Service to compatible versions.

Capture the MiCollab Client Service dsm.log and contact support.

Check the IP, Port and password set for the node. Correct the information and try the sync again.

Retry sync after 5k PBX becomes operational.

Page 2 of 2

Collaboration server synchronization message

Table 25 Collaboration Server synchronization error message lists the collaboration server error

message that may appear in the MiCollab Client Service Administration interface during a collaboration server synchronization.

163

MiCollab Client Administrator Guide

Table 25: Collaboration Server synchronization error message

Error Message

Unknown host exception.

Probable Cause Corrective Action

This error message may appear in the

MiCollab Client Service Administrator interface on the Collaboration Server

Details page when you click Sync Now.

This error message indicates that the

MiCollab Client Service cannot resolve the hostname for the collaboration server.

Restart MiCollab Client Service, and then attempt the synchronization with the collaboration server again.

Alarms/Events

This section describes the Alarms/Events available from the Event Viewer option in the MSL Server

Manager Administration menu (see page 146).

Alarms/Event include:

•

SIP connection event messages

below

•

“Presence event messages” on page 165

•

“SIP Registrar event messages” on page 165

•

“Watchdog messages” on page 166

SIP connection event messages

Table 26 SIP connection event messages provides information about SIP Connection Event

Messages.

Table 26: SIP connection event messages

Alarm/Event Description Probable Cause

Failed to create listen socket for IP/Host. Unable to open a socket for the IP and port specified in the event.

Active SIP Connection of type [1] established with [IP port].

Passive SIP Connection of type [1] established with [IP port].

The Severity Cleared means the connection established with the specified IP/Port has been removed.

The Severity Cleared means the connection established by the specified IP/Port has been removed.

<number> connections received from

<ip> in last second. Total connections

<number>. Max Allowed Connections

<number>.

Corrective Action

Check if port specified is already in use.

Either MiCollab Client has closed the connection or could happen due to network issues.

The specified IP is trying to open more connections per second than allowed.

Check if the IP is trying to DNS attack. If it is a trusted node like

MiVoice Border Gateway then add it in the trusted list on admin portal.

<number> connections were received from <ip>. Max Allowed Connections are

<number>.

The specified IP is trying to establish more connections than allowed.

Check if IP is trying DNS attack.

If it is a trusted node like

MiVoice Border Gateway then add it in a trusted list on admin portal.

164

Troubleshooting

Presence event messages

Table 27 Presence event messages provides information about Presence Event Messages.

Table 27: Presence event messages

Alarm/Event Description

Max. Session Limit Reached.

Probable Cause Corrective Action

Total number of presence sessions allowed has reached the limit allowed in the MiCollab Client

Service.

Check the number of presence sessions using the

Administrator interface. Shut down some MiCollab Clients or restart ACCTPRES module/ softswitch if you believe that the number of MiCollab Clients should be much smaller than reported.

Queue size has reached size <number> for Presence Notification Queue.

Rejecting SIP message.

Total number of pending

Notifications is exceeding the threshold.

The presence server gaps the notifications at some preconfigured rate in order to prevent server/client overload.

Check CPU/IO usage and re-configure the gapping rate if needed. This event is not an error but just an indication of presence server load.

Invalid SIP message was received. Check the client that sent the message about validity of the

SIP message.

Queue size has reached size <number> for <subscription>.

Account Presence Subscription

<subscription id> from <subscriber> to

<presentity> terminated. Reason -

<reason description>

Total notification pending for a subscriptions are more than the subscriber can consume.

This can indicate a slow client or a large number of notifications for a specific subscription. This is just an indication and not an error condition.

MiCollab Client Service’s presence subscription was terminated for the reason specified.

This is a diagnostic alarm raised whenever the presence subscription is terminated on

MiCollab Client Service. It is used for troubleshooting presence issues on the server.

SIP Registrar event messages

Table 28 Registrar event messages

provides information about Registrar Event Messages.

Table 28: Registrar event messages

Alarm/Event Description Probable Cause Corrective Action

Registration for [<account information>] with resource [<registration>] from device [<device>] userAgent [<user

agent>] callId [<SIP call id>] expired.

MiCollab Client has shut down or network issues are occurring.

Restart the MiCollab Client or check if network connectivity between the client and server is working.

165

MiCollab Client Administrator Guide

Table 28: Registrar event messages (continued)

Alarm/Event Description Probable Cause

Total [<number>] Registrations expired.

A specified number of registrations expired at the same time.

Corrective Action

Check if there are any network issues occurring that may prevent clients from registering with the server.

Watchdog messages

Table 29 Watchdog messages provides information about Watchdog Messages.

Table 29: Watchdog messages

Alarm/Event Description

Congestion update from module

DB_CHECK, congestion type cpu, congestion level 1, description cpu_yellow, details cpu_average.

Probable Cause Corrective Action

MiCollab Client Service has CPU congestion which is indicated by level of RED (85% cpu), ORANGE

(70%), YELLOW (50%), GREEN

(0%) in order of severity. The levels can be configured on the MiCollab

Client Service manually if needed.

These notifications do not indicate a problem but rather load on the server, and are helpful when troubleshooting server issues.

Resource usage capacity exceeded for resource cpu, resource type cpu, resource description cpu_yellow, capacity <capacity %> .

Current server congestion level 2, description CONG_ORANGE,

DebugLevel: 0, BlockProvisioning: 0,

BlockSIPRegistration:

0,PercentInboundDrops: 0,

PercentOutboundDrops: 0, reason cpu

The resource CPU has exceeded capacity (specified in alarm) utilization.

These notifications include pre-configured thresholds (50,

70, 85) raised by the server whenever the CPU exceeds the threshold. These notifications do not indicate a problem but rather load on the server, and are helpful when troubleshooting server issues.

MiCollab Client Service has taken the specified actions on server congestion level specified in the alarm (for example, Debug level has been set to 0 (WARNING).

This alarm indicates that actions have been taken by

MiCollab Client Service based on the congestion level.

MiTAI error codes

Table 30 MiTAI error codes

provides troubleshooting information about MiTAI error codes. These

error codes appear in the PBX_Proxy log file (see page 147).

MiTAI Error Code

SXERR_DEVICE_ALREADY_MONIT

ORED

Table 30: MiTAI error codes

Description

An attempt was made to monitor the same device more than once.

Probable Cause

MiCollab Client has attempted to monitor the same device more than once. This error should be treated more as a warning.

Page 1 of 2

166

Troubleshooting

Table 30: MiTAI error codes (continued)

MiTAI Error Code

SXERR_FEATURE_NOT_ALLOWED A MiTAI call processing service invocation failed because the device was in a state in which the service could not be completed.

SXERR_INVALID_CALL_ID

Description Probable Cause

A switch configuration is preventing the completion of an operation on a call.

The specified call-ID is not valid.

The call-ID can change at the device before the application invokes a call manipulation routine or the call-ID was never valid.

A race condition.

SXERR_INVALID_PBX_HANDLE

SXERR_INVALID_DN

SXERR_NO_CALL_TO_CLEAR

SXERR_NO_CALL_TO_ANSWER

SXERR_PRIVILEDGE_VIOLATION

SXERR_UNSPECIFIED

An hPbxObject supplied to a MiTAI routine was not valid. The ICP was previously closed or never opened.

Internal MiCollab Client error resulting from a race condition.

A specified SX_DN is not valid.

MiCollab Client is attempting to monitor an invalid extension.

The extension no longer exists on the switch.

A MiTAI call manipulation routine attempted to clear a call when none was present at the specified device.

A race condition occurred when both parties hung up at the same time.

A MiTAI call manipulation routine attempted to answer a call. No active call existed, possibly because the call had cleared before the routine took effect.

A race condition occurred when the caller hung up at the same time the call was answered.

The invoker of the MiTAI service does not have sufficient privileges.

MiCollab Client is attempting to perform an operation that is not allowed by the device's class of service.

An error of unknown origin. A GPF occurred within the

MiTAI library as a result of passing bad data to it. This is a

MiCollab Client internal error.

Page 2 of 2

Server log files

The following server log files are located in the

/opt/intertel/log

directory on the MiCollab Client

Service and provide valuable information when diagnosing MiCollab Client problems:

• pbxProxy.log: Provides MiTAI command and event related information for the MiVoice Business

PBX.

• Proxy5k.log and 5kCmdEvts.log: Provides OAI command and event related information for the MiVoice Office 250 PBX.

• jboss.log: Provides information for:

• The MiCollab Client Service Administrator interface

• Web services for client presence status updates

167

MiCollab Client Administrator Guide

• MiCollab Audio, Web and Video Conferencing collaboration interaction

• Web portal features

• Call control commands received by the MiCollab Client Service from the MiCollab Desktop

Client and MiCollab Web Portal

• sipregistrar.log: Provides information about SIP registration for the MiCollab Desktop Client.

• sipbaccountpresence.log: Provides information for telephony and account presence features.

• imevents.log: Provides information for chat-related features.

• proxy.log: Contains the SIP messages sent from and received by MiCollab Client Service.

• rps.log: Includes server side information related to peering such as which MiCollab Client Service connected and what information was requested.

• rtc.log: Includes peering related information on accounts synchronized from MiCollab Client

Service that this MiCollab Client Service connects to.

• federationgw.log: Includes log entries related to XMPP-based IM/Presence federation with third-party systems such as Microsoft OCS.

• /var/log/prosody/prosody.log: Includes the XMPP messages and other XMPP server details for IM/Presence federation with third party systems.

Log files can be viewed or downloaded from the server using the MSL Server Manager View log

files function.

Logs in the

/opt/intertel/log

directory appear as uc_server/<file name>

(for example, uc_server/pbxProxy.log.1

To use the Server Manager View Log Files function:

Open a Web browser and navigate to the MSL server manager URL (for example,

https://<MSL_server_FQDN>/server-manager

) where the MiCollab Client Service is installed. The server manager log in page appears.

In the left navigation pane under Administration, click View Log Files.

Select a log file from the list provided by the Choose a log file to view field.

For information about MSL administrator tasks, see the MSL Server Manager online help or the

MSL Installation and Administration Guide available on the Mitel eDocs Web site

(http://edocs.mitel.com) for details and instructions.

For specific problems gather the log files noted below:

• For MiCollab Client Service Administrator interface problems, review the jboss.log* file.

• For account synchronization problems, log files include:

• epm3300.log.*

• adepm.log.*

• dsm.log.*

168

Troubleshooting

• jboss.log.*

• For chat problems, log files include:

• sipims.log.*

• imevents.log.*

• For IM problems, log files include:

• imevents.log.*

• proxy.log.*

• For call, presence, and offline client problems, log files include:

• pbxProxy.log.* (MiVoice Business PBXs)

• Proxy5k.log.* (MiVoice Office 250 PBX)

• 5kCmdEvts.log.*(MiVoice Office 250 PBX)

• sipbaccountpresence.log.*

• jboss.log.*

• acctpres.evts.*

• proxy.log.*

• sipregistrar.log.*

* Includes all log files with this file name.

AD/LDAP synchronization log file

The AD/LDAP synchronization module is known as ADEpm. This module creates a log file named adepm.log, which can be used to debug AD/LDAP synchronization errors (see

Table 23 on page 161 ).

To access the adepm.log file:

Open a Web browser and navigate to the MSL server manager URL (for example,

https://<MSL_server_FQDN>/server-manager

) where the MiCollab Client Service is installed. The server manager log in page appears.

In the left navigation pane under Administration, click View Log Files.

Select uc_server/adepm.log

from the Choose a log file to view list.

Click Next. Server Manager displays the adepm.log file.

The synchronization summary appears at the bottom of the adepm.log file between the SUMMARY

BEGIN and SUMMARY END tags in the file and includes:

•

“Domain synchronization summary” on page 170

•

“Account totals” on page 171

169

MiCollab Client Administrator Guide

Figure 9 provides an example of a synchronization summary. This MiCollab Client Service has two

AD/LDAP Synchronizers, logged as two domains: california_branch and newyork_branch.

Figure 0-6

170

Figure 9: Synchronization summary example

Domain synchronization summary

Domain summaries are displayed after the SUMMARY BEGIN tab.

Each domain corresponds to one AD/LDAP Synchronizer that has been defined on the

Synchronization tab in the MiCollab Client Service Administrator interface. Domain summaries are output for each AD/LDAP Synchronizer.

Domain summaries include the following information:

• Actions: Describes the various actions taken on the accounts for that domain. For example, for the california_branch domain example:

• 2 accounts were sent for account creation. This indicates that 2 accounts passed through all the synchronization pre-processing and were sent out to other MiCollab Client Service modules for further processing.

Troubleshooting

• 2 accounts were rejected because: PBX Node IP is not set. This indicates that these 2 accounts did not have a valid PBX Node IP attribute populated and were therefore rejected

(PBX Node IP is a mandatory parameter for AD/LDAP sync). This can happen because the field mapping is incorrect (pointing to an invalid LDAP attribute name) or the accounts did not have any value for that attribute.

• Other Errors: Describes other problems, which can be due to incorrect configuration or incorrectly populated account details on the LDAP server. For example, 14 accounts were rejected

because: Neither Deskphone nor Softphone attributes are set.

• Account Names: Lists the account names of the accounts in each category. This list allows you to focus on one account and examine why it was or was not rejected. For example, Accounts

for which PBX Node IP is not set: CN=John D. Smith|CN=John Doe|.

Account totals

Account totals are displayed just before the SUMMARY END tag.

Account totals provide account counts for the various processing categories. Account totals should add up to the category counts from all the domains.

Account totals include the following information:

• Accounts pulled from LDAP server: This is the total number of accounts retrieved from the

LDAP server. Currently, MiCollab Client can retrieve a maximum of 9000 eligible accounts from the LDAP server. If the LDAP server contains more than 9000 eligible accounts, those accounts in excess of the 9000 account maximum will not be retrieved.

If no accounts were pulled from the LDAP server, one of the following may have occurred:

• The synchronizer configuration did not contain any eligible accounts. Note that an overly restrictive LDAP query can cause this.

• A synchronization error occurred. Synchronization errors are displayed at the top of the domain summary. For example:

Error: Error establishing LDAP Context for url ldap://127.0.0.1:389/DC=test,DC=mitel,DC=com: [LDAP: error code 49 -

80090308: LdapErr: DSID-0C090334, comment: AcceptSecurityContext error, data

52e, vece

• Accounts sent for account creation: This is the total number of accounts that should be created on MiCollab Client Service if the synchronization is successful.

If you do not see this many accounts on your MiCollab Client Service, the following issues may be the cause:

• Synchronization incomplete: The synchronization process may not be complete yet. Refresh the Synchronization tab on the MiCollab Client Service Administrator interface to show the status of the synchronization.

• Insufficient licenses: MiCollab Client Service may not have a sufficient number of licenses available to create all of the accounts. View the dsm.log.* and jboss.log.* files for further details.

171

MiCollab Client Administrator Guide

• Incorrect PBX Node IP address: Accounts may not have their PBX Node IP address set to one of the configured PBX Nodes in the MiCollab Client Service Administrator interface.

Note:

MiCollab Client Service does not convert IP addresses to hostnames and vice versa. For example, if the PBX Node has been configured as an IP address on MiCollab Client Service, then the accounts being synchronized should also include an IP address in the PBX Node IP field. View the dsm.log.* file for further details.

• Accounts rejected: This is the total number of accounts that were rejected when the synchronization occurred due to invalid, missing, or incorrectly mapped LDAP attributes.

License and PBX changes

Follow these guidelines about which action to perform on the MiCollab Client Service administrator interface for license and PBX changes. See the online help for instructions.

• Licensing changes: Adding a licensed feature to your installation requires you to perform a synchronization with the AMC from the MSL Server Manager interface. After the license synch with AMC, you may have to wait up to 15 minutes for the AMC_AGENT module in MiCollab

Client Service to update the MiCollab Client Service database with the license information. If after 15 minutes, it does not appear that the license is enabled, restart the MiCollab Client

Service.

• Changing a Directory Number (DN) on the PBX: Changing line configuration requires you to complete a line monitor refresh (MiVoice Business only) for the node using the Administrator interface. No restart is required.

• Adding a DN on the PBX: Adding a DN requires you to complete a manual synchronization for the PBX node if the DN needs to be pulled into the MiCollab Client Service database. No restart is required.

• Deleting an Existing DN: Deleting a DN from the MiCollab Client Service database requires you to complete a manual synchronization for the PBX node. No restart is required.

• Changing Voice Mail: Changing voice mail numbers does not require a MiCollab Client Service restart.

Account reactivation following license changes

After making licensing changes to MiCollab Client such as restoring a license or installing a license, you may need to reactivate accounts in the MiCollab Client Administrator interface.

When a license is revoked, the user will be unable to use the feature or device in the MiCollab

Desktop Client.

To properly provision licensed features to MiCollab Client users, you must do all of the following

• Verify MiCollab Client licenses from the AMC (see

“Verify MiCollab Client Service licensing” on page 100 ).

•

Sync the MiCollab Client Service with the AMC to update licenses (see page 100

• Provision the features to users in the MiCollab Client Administrator interface:

172

Troubleshooting

• Create a Feature Profile by selecting the licensed features for the profile.

• Assign the Feature Profile to accounts.

See the MiCollab Client Service Administrator interface online help for details.

The following procedure describes how to reactivate accounts after making licensing changes.

To reactivate licensed features:

Open a Web browser and navigate to the MSL server manager URL (for example,

https://<MSL_server_FQDN>/server-manager

) where the MiCollab Client Service is installed. The server manager log in page appears.

Under ServiceLink, click Status. The ServiceLink Status Information page appears.

Verify that the status and expiration for the Mitel MiCollab Client Service subscription is valid and active.

Under Applications, click MiCollab Client Service.

Click Configure Mitel MiCollab Client Service.

Click the Accounts tab. The Accounts tab displays an Active column when at least one account is inactive.

Select the accounts to activate and click Activate.

When prompted to confirm the activation, click OK.

Calendar integration troubleshooting

This section provides troubleshooting information for Calendar Integration on MiCollab Client.

Failure to successfully connect to the Exchange or Office 365 server

When configuring the Exchange or Office 365 server from the Enterprise Tab of the MiCollab Client

Administration Tool, the following error can be encountered when testing the connection:

Invalid calendar server credentials

If this error is encountered, perform the following steps:

Re-enter the credentials and click the Test Connection button again to rule out spelling errors.

Ensure that no one in your organization has changed the password for the account being used for MiCollab Client-Exchange integration.

Verify that the IIS Webserver on the Exchange server has enabled at least one of Basic or Digest authentication mechanism. MiCollab Client Service does not support NTLM authentication mechanism (also known as Windows Authentication) and will fail authentication if that is the only type of authentication enabled on Exchange server. To verify this, do the following:

173

MiCollab Client Administrator Guide a.

PuTTY onto the MiCollab Client Service and run the following command. Replace the Ex-

change URL and user/password with one reflecting your configuration. If you have enabled only digest authentication on the Exchange server, then change the –-basic to –-digest in the curl command options:

C curl -v --insecure --basic -u 'administrator:password' -d '' https://exchange.mitel.com/ews/exchange.asmx

This command should NOT return 401/403 response codes. If it does, then you may need to enable Basic/Digest authentication on the Exchange server. More specifically, look at the HTTP headers shown in the curl response. The WWW-Authenticate headers should contain Basic and/or Digest (for example, WWW-Authenticate: Digest qop="auth",... OR WWW-Au-

thenticate: Basic realm="10.101...). If the response has only NTLM header (such as WWW-Authenticate: NTLM), then your Exchange server is configured for only NTLM.

To enable Basic/Digest authentication (this applies for Windows Server 2003 R2 – your exact steps may vary):

Start IIS Manager: Start -> All programs -> Administrative Tools -> Internet Information

Services (IIS) Manager.

Navigate to EWS: (Local computer -> Web Sites -> Default Web Site -> EWS).

Right click -> Properties -> Directory Security -> Authentication and access control -> Edit.

Check Digest, Basic, or both. Apply and Save.

From the DOS prompt, enter:

iisreset.exe /RESTART f.

Attempt the curl command again. The curl command may show a 500 response, which is acceptable. It should not show a 401/403 response.

• For Exchange 2013 server, see http://www.itnotes.eu/?p=2455.

Google calendar integration error after database backup and restore or MSL upgrade

When MSL is upgraded (or after database backup and restore), the Google OAuth2 tokens are lost

(this is due to security reasons, so that the refresh token may not be read from a DB backup).

Therefore, the Google OAuth2 configuration has to be redone. Until that configuration is complete, the MiCollab Client will disable Google calendar integration and will retry every 15 minutes (with default configuration) to re-read the OAuth2 tokens. When MiCollab Client tries to read the tokens and fails it raises and alarm and sends error notifications to MiCollab Clients (to the effect that the access token is empty).

The MiCollab Clients will receive these error popups (see below) every 15 minutes until the OAuth2 configuration is complete. To minimize this impact, you should re-configure OAuth2 as soon as the

DB restore or MSL upgrade is done.

174

Troubleshooting

MiCollab Desktop Client troubleshooting

This section provides troubleshooting information for the MiCollab Desktop Client.

Problem reporting tool

The Problem Reporting tool, available from the MiCollab Desktop Client, allows users to create a problem report and send it to you. Users can access the tool from the MiCollab Desktop Client main menu.

In addition, if an exception occurs that forces a client shut down, the error message generated includes the option to report the problem. This option is selected by default.

The Problem Reporting Tool dialog box prompts the user to provide both a brief and detailed description of the problem.

By default, the MiCollab Desktop Client attaches the following compressed log files to the report:

• ucc.log.

• SipSubscriber

• uca.dmp (if available)

• SoftphoneManager.log

After the user sends the report, the log files sent by the MiCollab Desktop Client are combined with server log files into a single ZIP file. You receive an e-mail message notifying you that a problem report has been generated, the name of the ZIP file, and the log files that are included. The e-mail message provides the descriptions that the user entered in the Problem Reporting Tool dialog box.

An example of an e-mail message generated from a problem report is shown in

Figure on page 176 .

Note:

The report is sent to the e-mail address configured in the MSL Server Manager interface under

Configuration – E-mail settings – Forwarding address for administrative e-mail (see

page 98 ).

It is assumed that the MiCollab Client administrator and the MSL administrator are the same person.

The compressed log file included with the report is stored on the MiCollab Client Service in the

/var/log/feedback directory. The file includes a timestamp that indicates when it was generated.

The timestamp includes year, month, calendar date, hour, minute, and second.

Client log files sent to the server can be retrieved using the MSL Server Manager View log files function (see

“Server troubleshooting” on page 160 ). After 30 days client log files are automatically

deleted from the server.

For information about MSL administrator tasks, see the MSL Server Manager online help or the MSL

Installation and Administration Guide available on the Mitel eDocs Web site (http://edocs.mitel.com) for details and instructions.

1. Includes all logs with this file name (see page 176).

175

MiCollab Client Administrator Guide

Additional Client log files and troubleshooting tools

Table 31 MiCollab Client log files and troubleshooting tools

provides information about the MiCollab

Client log files and troubleshooting tools.

The default installation directory for MiCollab Client varies for 32-bit vs. 64-bit operating systems:

• 32-bit:

C:\Program Files\Mitel\MiCollab Client 6.0

• 64-bit:

C:\Program Files (x86)\Mitel\MiCollab Client 6.0

Specific to MiVoice for Skype for Business client:

• 32-bit:

C:\Program Files\Mitel\LyncPlugIn

• 64-bit:

C:\Program Files (x86)\Mitel\LyncPlugIn

Table 31: MiCollab Client log files and troubleshooting tools

Location Log File/Tool Description

<client installation directory> Includes IP settings/ports for the MiCollab

Client Service, Collaboration server and telephony server of client. NHtraceswitch settings for logging.

<client installation directory> Executable used to launch MiCollab Client application.

For Windows Vista/Windows 7

C:\users\<username>\AppData\

Roaming\Mitel\MiCollab uca.log

1 uc.mdb

user.config

SipSubscriber.txt

uca.dmp

Main log file for the MiCollab Desktop Client.

Client database which contains call log, contacts, groups, and messenger IDs.

user.config contains all persistent settings of the application, including configuration settings and UI layout settings. Deleting this file resets the MiCollab Desktop Client to default settings.

Includes low level logging for the SIP component of MiCollab Client.

A Microsoft mini-dump file, created if the client shuts down unexpectedly.

SoftphoneManager.log

Provides logs for the Softphone process, which handles the softphone component of MiCollab

Client.

1. Includes all logs with this file name.

176

Troubleshooting

MiCollab Desktop Client troubleshooting table

Table 32 Client troubleshooting issues provides troubleshooting information for the MiCollab Desktop

Client.

Table 32: Client troubleshooting issues

Problem or Error Probable Cause Corrective Action

Users are unable to connect to the server using MiCollab Desktop

Client, but can connect using

MiCollab Web Portal or MiCollab for

Mobile.

Server certificate has expired.

Update the certificate and restart

MiCollab Client Service.

Users are experiencing difficulty with dialing rules.

To control how MiCollab Client dials numbers, users should configure Windows dialing rules and use the International Dialing

Format.

Instruct the user to see the Phone

Number Formats topic in the MiCollab

Desktop Client help for additional information.

No phone devices are available.

MiCollab Client cannot set a

MiTAI monitor, or there is a firewall blocking or other network issue.

Check the following:

• On MiVoice Business PBXs check system options to ensure “MiTAI computer” is set to Yes.

• Ensure MiVoice Business COS for the MiCollab Client sets has

“HCI” enabled.

• Ping the MiVoice Business PBX.

• Ping the desk phone.

• Does the desk phone have the same issue? (independent of

MiCollab Client)

• Is the problem local or remote?

• Are VLAN’s configured properly?

• Check VPN.

• Is telephony service started?

• Check telephony server logs for errors.

• Stop and restart telephony server service.

• Use MiTAI test tool to verify if it is a

MiTAI issue.

If it fails check MiVoice Business programming.

Page 1 of 4

177

MiCollab Client Administrator Guide

Table 32: Client troubleshooting issues (continued)

Problem or Error Probable Cause

Calls to busy internal number do not display in Call History.

Show Call to Busy Number in

Call History is False.

Corrective Action

User joins a collaboration session as a participant rather than the leader when launched from MiCollab

Client. If they join the Web conference from the MiCollab Audio,

Web and Video Conferencing interface, they are correctly joined as the leader.

MiCollab Audio, Web and Video

Conferencing has LDAP enabled and LDAP sync is set.

Users login name and username of the work e-mail address are set different then account on

MiCollab Client.

Add the user work e-mail as the first e-mail address under contact information for that account.

Change

"ShowCallToBusyNumberInCallHistor y" in user.config to "True".

No presence, or client keeps changing from online to offline.

MiCollab Client or MiCollab

Client Service is not communicating with the presence server.

The External Dial feature was removed from the user’s account, but the click to call functionality is still enabled on the user’s computer.

The External Dial feature was not completely removed from the account.

“Failed to initialize VBox” message appears, interface locks up.

MiCollab Desktop Client Interface fails to display completely or stops responding.

MiCollab Client is conflicting with VBox. VBox is an anti-piracy / copy protection application that is included in a number of applications, including ACT!.

MiCollab Client is running on a computer that has an out-of-date video driver.

Check the following:

• Has the presence server service started?

• Does the MiCollab Client Service have a DNS entry?

• Is the MiCollab Client Service communicating with the Presence server on the correct port?

• Is the telephony server working properly?

• Is the MiCollab Client communicating with the Presence server?

• Check uca.log and verify the ports.

• MiCollab Client firewall blocking necessary ports.

• Check Presence server log and see if it is updating.

• Check telephony server logs to see if it keeps losing connectivity.

To remove the External Dial feature

(and disable click to call on the

user’s computer):

1. Disable the External Dial feature in the user’s account.

2. Reinstall the client on the user’s computer.

If you are using ACT!, ensure that it is fully licensed rather than using a trial version. If this error is occurring regardless of the status of your ACT! license, contact your software provider.

Update the computer’s video driver with a current version.

Page 2 of 4

178

Troubleshooting

Table 32: Client troubleshooting issues (continued)

Problem or Error

Calls are not routing to the device specified for the Dynamic Status.

Probable Cause Corrective Action

The user has enabled forwarding using the Phone

Settings - Forward my calls to option, which overrides the normal routing specified in the

Dynamic Status.

The options the user selects on the

Phone Settings tab for the Dynamic

Status (Add/Edit dialog box - More

Options) override the routing specified in the Send my calls to field. Instruct users to specify call routing using the

Send my calls to field and leave the fields in the Phone Settings tab blank.

The proper COS options are not enabled for the device in the user’s Personal Ring Group.

Verify that the proper COS options are enabled for devices in the user’s

Personal Ring Group.

The user cannot access voice mail messages from the MiCollab

Desktop Client’s Visual Voice Mail view.

The user’s list of default Dynamic

Statuses is deleted.

The user was accessing his or her voice mailbox using the

Telephony User Interface (TUI) when he or she logged in to the

MiCollab Desktop Client and the

Visual Voice Mail view failed to load.

Instruct the user to disconnect from his or her voice mailbox, exit the MiCollab

Desktop Client, and log back in to the

MiCollab Desktop Client.

This problem occurs when an account created earlier

(manually or via PBX or LDAP synchronization) is deleted and then recreated using any of the possible approaches.

Instruct the user to

“Repair the

MiCollab Desktop Client” on page 156

to re-establish the default list of

Dynamic Statuses.

A remote MiCollab Client user on the

MiVoice Office 250 PBX sent or received an instant message, which caused the MiCollab Desktop Client to go offline.

SIP Fixup is enabled in the firewall.

Disable SIP Fixup completely, or disable it for SIP messages sent to

MiCollab Client Service.

The user has selected an EHDU device for call routing from his or her

Ring Group, but calls are not routing to the external number.

The external number is not logged into the EHDU.

The user is unable to upgrade the

MiCollab Desktop Client to a er software version and also cannot uninstall the current version.

• There is a possible Microsoft

Windows Installer issue on the user’s PC.

• Windows Installer Service caches the location of the installer and uses that location when it upgrades to invoke the uninstall portion of the previous install. In this instance the previous installer is no longer available

Manually log the external number in or select “Permanent Login” from the

Class of Service options.

Use Add/Remove Programs from the control panel to uninstall the MiCollab

Desktop Client, and then install the client version. For additional information, see:

• Mitel KB article

4759

• Microsoft KB article 2438651

Page 3 of 4

179

MiCollab Client Administrator Guide

Table 32: Client troubleshooting issues (continued)

Problem or Error Probable Cause Corrective Action

When the user tries the “Call me and play messages” function from the

Visual Voice Mail view, nothing happens.

There is a possible configuration issue with the MiCollab UM application.

For all voice mail function to operate properly, MiCollab Client requires certain parameters be configured for

MiCollab UM. See “MiCollab UM configuration” on page 90 for details.

You cannot establish a call using your SIP softphone on your MiCollab

Desktop Client in Teleworker mode even though your SIP softphone is registered.

Utilizing an unsupported router:

D-Link DIR-615.

MiCollab Desktop Client unable to connect after uploading the new client software. Gets prompted to upgrade but will not connect.

You should try a different router.

Microsoft Video Network connection gets created when a

USB camera is installed.and a new driver is applied which impacts our product to connect to the MiCollab Client Service

(MiCollab Client picks an invalid

IP connection).

Reboot the PC and Windows will remove this invalid video connection.

Some of the Google contacts are not imported on the MiCollab Desktop

Client. Occurs after contacts are moved from the main corporate directory to a personal group.

Google send these contacts with no name when MiCollab Client imports it. Also see defect report against Google. http://code.google.com/a/googl e.com/p/apps-api-issues/issues

/detail?id=3171

The workaround is to go to that group and re-enter or edit the name then it will import properly.

When the MiCollab server is in offline mode, and there is a call between a Minet soft phone and a desk phone and the deskphone puts the softphone on hold and then retrieves the call, the Minet softphone intermittently fails to recognize that call is retrieved by the desk phone.

The Minet Soft phone call window is not updated to represent established state.

Audio between phones is established and Minet soft phone users is able to clear call.

Audio channels are established because it directly corresponds to MiVoice Business.

There is no workaround at this time.

Page 4 of 4

MiCollab Desktop Client error and warning messages

This section provides common error and warning messages for the following situations:

•

Initialization messages below

•

“Configuration change messages” on page 182

180

Troubleshooting

•

“Teleworker setup message” on page 183

•

“File sending message” on page 183

•

“ACD messages” on page 183

•

“PIM integration messages” on page 183

Initialization messages

Table 33 Initialization messages lists client initialization messages and their possible causes.

Table 33: Initialization messages

Message

MiCollab Client failed to connect to server

<FQDN>. MiCollab Client will start up in

Offline mode. Do you wish to continue?

Possible Cause Options

• The MiCollab Client Service is not running.

• There is no route to the MiCollab Client

Service.

• MiCollab Client cannot set a MiTAI monitor on the extension number.

• There may be a firewall/network/DNS issue or a PBX configuration problem.

• A remote user is trying to connect without configuring teleworker settings. Remote

MiVoice Business users must configure teleworker settings after acknowledging this error.

• Show Details

• OK

• Cancel

There are no devices available (desk phone:<ext> or softphone <ext> on switch xxx.xxx.xxx.xxx). Would you like to work offline?

• The MiCollab Client Service has not finished configuring the system.

• The telephony server is a MiTAI proxy from the MiCollab Client Service to the MiVoice

Business PBX. If the telephony server loses connectivity to the PBX then

MiCollab Client loses it’s MiTAI monitor of the MiCollab Client extension.

• A user does not have either a deskphone or softphone extension programmed in the

MiCollab Client Service.

• OK

• Cancel

MiCollab Client failed to connect to the

MiCollab Client Service through the

Teleworker Gateway. MiCollab Client will startup in Offline mode. Do you wish to continue?

• The user ID was not found on the MiCollab

Client Service.

• There was a port issue between MiCollab

Client or the MiCollab Client Service and the teleworker gateway.

• Show Details

• OK

• Cancel

Irreconcilable discrepancy between the

MiCollab Client’s set of lines and the PBX’s set of lines. Restart MiCollab Client.

• Line changes have been made on the switch.

• MiCollab Client and the PBX switch are out of synch. Restart the MiCollab Client

Service.

Page 1 of 2

181

MiCollab Client Administrator Guide

Table 33: Initialization messages (continued)

Message

Your device appears to be out of service.

Please contact your system administrator for assistance. Would you like to go to offline mode now? Click OK to continue to use MiCollab Client in offline mode. Click

Cancel to quit MiCollab Client.

Possible Cause

The desk phone is not plugged in.

Options

• OK

• Cancel

This is a Demo version of MiCollab Client and will startup in Offline mode. For a fully licensed copy of MiCollab Client, please contact your System Administrator. Do you wish to continue?

• If the MiCollab Client Service is licensed (a license key has been applied) but the user trying to log in does not appear in the

MiCollab Client Service then they will receive this message and be able to login offline.

• The user logging in may be listed as an account on the MiCollab Client Service, but doesn't have a MiCollab Client base license assigned to it, will get this error and be able to log in using offline mode.

• OK

• Cancel

Your account is not licensed for desk phone or softphone. Please contact your system administrator. Would you like to work offline?

The user's account does not have both deskphone and softphone licensing.

• OK

• Cancel

Page 2 of 2

Configuration change messages

Table 34 Configuration change messages

provides configuration change warning messages and their possible causes.

Message

Table 34: Configuration change messages

Possible Cause Options

Changes to the user interface language will not take effect until you restart MiCollab

Client.

This message is displayed when the language settings have been changed.

There are changes made to the configuration of MiCollab Client that have not been applied yet. Please choose what you would like to do with them.

This message is displayed when configuration changes have been made then the user cancels out of the configuration screen without saving or applying the changes.

• Apply

• Review

• Discard

182

Troubleshooting

Teleworker setup message

Table 35 Teleworker setup message provides a teleworker setup message.

Table 35: Teleworker setup message

Message Possible Cause

Directory number is not valid. Please type in the correct value and try again.

An invalid directory number was entered (non numeric)

Resolution: Re-enter the directory number.

Options

Configuration file for SSL component is invalid.

The user was attempting to retrieve a certificate from the

MiCollab Desktop Client Configuration\Teleworker

Settings dialog box when he or she received this message. This certificate error occasionally occurs after an upgrade from MiCollab Client 2.0 or YA 5.0.

Instruct the user to restart the MiCollab Desktop Client and try retrieving the certificate again.

File sending message

Table 36 File sending message

provides a file sending message.

Message

Table 36: File sending message

Possible Cause

The file or files you attempted to send exceed the maximum file transfer size of 10 megabytes.

While in the People view or chat window attempting to send a file over 10 megabytes to another MiCollab Client user.

Options

ACD messages

Table 37 ACD messages provides ACD errors and their possible causes.

Table 37: ACD messages

Message

Either the agent does not exist, is already logged in elsewhere, or the phone you are monitoring is not configured for ACD. Press

OK to return to MiCollab Client.

Possible Cause

• An incorrect Agent ID has been entered.

• Agent selected is already logged in elsewhere.

• Phone not configured for ACD.

The Agent ID is invalid. The Agent ID cannot be blank.

The agent Id has not been entered.

Options

PIM integration messages

Table 38 PIM integration messages

provides PIM integration messages and their possible causes.

Table 38: PIM integration messages

Message

Microsoft Outlook is running under another profile. Please restart this application under the default profile.

Possible Cause Options

User selected some profile other than the default mail profile (set in the Windows Control Panel

“Mail”) when the PIM was started.

183

MiCollab Client Administrator Guide

Table 38: PIM integration messages (continued)(continued)

Message

MiCollab Client is experiencing issues using

Microsoft Outlook. Please make sure this application is working properly and try again.

Possible Cause Options

The PIM is malfunctioning in an unspecified way. OK

Please install and set up any of these supported applications before using this feature:

• Windows Address Book

• Act

• Microsoft Outlook

• Lotus Notes

User attempted to select PIM folders for importing or indexing contacts when no PIM was installed and configured.

Microsoft Outlook is not responding. Please make sure this application is working properly and try again.

The PIM is not responding. Restart the PIM and then restart the MiCollab Desktop Client.

Microsoft Outlook appears to be unavailable.

Please make sure this application is working properly and restart MiCollab Client when convenient.

The PIM is not available. MiCollab Client must be restarted when the PIM is working again.

184

Troubleshooting

Audio problems

Table 39 MiCollab Client audio problems provides Client troubleshooting information audio

problems.

Table 39: MiCollab Client audio problems

Problem or Error Probable Cause Corrective Action

When using a headset:

• MUTE button on the volume control of the headset turns on by itself, and will not turn off.

• Disconnecting and reconnecting the headset to the PC causes the system to freeze and require a power down and restart.

• Windows loses the connection to the USB headset. Windows no longer detects the headset.

• Loss of audio during a phone call, while the call window stays up.

• Answering or making a softphone call using, and experiencing no audio.

• Loud hissing, static or popping heard through the headset speakers.

• Windows loses the USB connection to the headset.

• MiCollab Client no longer detects the USB headset. (Tools -

Configuration - Handle Calls

Using).

• MiCollab Client automatically changes the audio devices for softphone calls to the PC sound card or another audio device.

The headset is defective or misconfigured on the PC.

Make sure that the USB headset connected to the MiCollab Client PC is functioning correctly.

• Ensure that Microsoft Windows is detecting the USB connected headset.

(Windows - Hardware Devices).

• Verify with the headset manufacturer that the correct drivers and firmware have been installed for the Microsoft

Operating System installed on the

MiCollab Client PC.

• Check the headset manufacturer's

Web site for white papers and support articles for related symptoms with the headsets. (i.e. Intermittent loss of audio, disconnects and reconnects causing system failure, etc.).

• Check the PC manufacturer's Web site for articles relating to USB device connectivity problems. (Root USB

Controller vs. front USB ports, USB power distribution, etc.).

Contact the USB headset vendor to ensure that the headsets are configured and operating as intended.

Page 1 of 2

185

MiCollab Client Administrator Guide

Table 39: MiCollab Client audio problems (continued)

Problem or Error

When using the softphone the call

“breaks up” while using other programs.

Probable Cause Corrective Action

Some Windows tasks run at elevated priorities, briefly preventing other applications from performing their own tasks.

Windows desktop tasks can run at the highest of priorities.

A common problem is the animation used when minimizing and maximizing windows.

This animation takes about

200 ms (1/5th of a second) and produces a noticeable break in a conversation.

To disable the animation in XP:

1. In the Windows Control Panel, select

Performance and Maintenance.

2. Select System Properties.

3. On the Advanced tab, click the

Performance “Settings” button.

4. Clear the “Animate windows when minimizing and maximizing” option in the Visual Effects tab.

One-way audio or no audio.

Firewall blocking or call path cannot route.

Check the gateway IP address. Is default gateway aware of all networks?

• In DMZ - NIC of external firewall.

• Ensure firewall isn’t blocking any necessary ports.

• Is it a fully routable path?

This is normal and unavoidable behavior.

Active SIP softphone call on data network (cellular data network) is disconnected when switching to a

WiFi connection.

3G/4G data and WiFi connections cannot operate simultaneously.

Page 2 of 2

186

Troubleshooting

Video problems

Table 40 MiCollab Client video problems

provides client troubleshooting information video problems.

Table 40: MiCollab Client video problems

Problem or Error Probable Cause

When a MiCollab Client Service A connected to 3300 MiVoice Business is peered with MiCollab Client Service B connected to MiVoice Office 250 PBX, then users on MiCollab Client Service A cannot escalate the SIP softphone audio call with another user on MiCollab Client

Service B, to video even though the call window shows the video button.

MiVoice Office 250 PBX does not support SIP Video

Corrective Action

Device error

Table 41 Device errors provides troubleshooting information for a device error.

Table 41: Device errors

Error Probable Cause Corrective Action

The “P-Asserted-Identity <MiVoice

Business IP Address>” error message appears on the 5610 SIP phone display when a call from the PBX rings in.

The “P-Asserted-Identity <MiVoice

Business IP Address>” header is included in the SIP INVITE message to the 5610 phone.

None. Although this error message appears on the display, the user can still answer and complete the call attempt.

187

MiCollab Client Administrator Guide

MiVoice for Skype for Business troubleshooting

Table 42 MiVoice for Skype for Business troubleshooting issues

provides troubleshooting items for

MiVoice for Skype for Business.

Table 42: MiVoice for Skype for Business troubleshooting issues

Problem or Error Probable Cause

User can log in but is unable to use any of the MiVoice features, such as setting DND, Call Forward, calling operations, etc...

User account is not licensed properly.

Corrective Action

From MiCollab Client Service, Accounts Tab go to Licensed Features and add Desk Phone and

Softphone licenses to user’s profile.

For deskphone only users, only SDK licenses are required from AMC but admin needs to assign SDK + Deskphone features to the user

(via MiCollab Client feature profiles on server).

For a user who has both softphone and

Deskphone, Admin will take SDK + softphone licenses from AMC and will assign SDK +

Deskphone + Softphone features to the user.

Also see

Table 2 .

Also need to restart the Skype for Business client after making a change to licenses

(MiVoice will automatically connect once the

Skype for Business client restarts).

Added custom attributes are not visible on

MiVoice for Skype for

Business

Only the default telephone fields (like Home, Mobile,

IP Phone and Work phone) which are visible to Skype for Business

Contact card by default will be visible to

MiVoice for Skype for Business

This is normal behavior. Any field which is added via custom attribute in Active Directory or MiCollab Client Service will not be visible to

MiVoice for Skype for Business

188

Troubleshooting

Web Portal troubleshooting

Table 43 Web Portal troubleshooting issue provides troubleshooting items for the Web Portal.

Table 43: Web Portal troubleshooting issue

Problem or Error

Attempts to log in to the desktop using the Safari Web browser fails in a crashed browser on iOS4 with an iPhone 3G.

When browsing with Safari to an untrusted site, you get the Cancel,

Details, Continue options. Click

Continue.

Probable Cause Corrective Action

Safari is set to AutoFill and capture logins.

Turn off the Autofill setting in the

Safari browser, and then try logging in again.

See “MiCollab Web Client requirements” on page 75 for a list

of supported browsers.

Connection fails when using Firefox

A red exclamation appears at the base of the MiCollab Web Portal.

Certificate issue.

Follow the steps below for WSP connection:

1. Type <server ip or name>:36008. For example, mas-uca-a.micloud.com:36008

2. When prompted, add the exception.

3. Log into the web client URL.

189

MiCollab Client Administrator Guide

Android Device troubleshooting

Table 44 Android troubleshooting issues provides troubleshooting items for Android devices.

Table 44: Android troubleshooting issues

Problem or Error Probable Cause

Incoming call to Android device may take up to 30 seconds before it starts ringing. Occurs after device is idle and has gone to sleep.

Advanced settings “Best Wi-Fi

Performance” is unchecked

(disabled).

Android Galaxy Nexus MiCollab for

Mobile crashes when making video calls to MiVoice Conference/Video

Phone even when video is set to lowest settings (web).

Unknown cause:

Galaxy Nexus falls within the minimum hardware specs. Video calls to other devices are not experiencing this issue.

Corrective Action

Set or enable the advanced settings

“Best Wi-Fi Performance”.

No corrective actions.

190

Troubleshooting

BlackBerry device troubleshooting

Table 45 BlackBerry device troubleshooting issue

provides troubleshooting items for BlackBerry devices.

Table 45: BlackBerry device troubleshooting issue

Problem or Error Probable Cause

The user’s BlackBerry device is displaying an HTTP 302 error when attempting to connect to the MiCollab Client

Service.

The Remote Proxy Services server (v2.0.4.0) is not properly formatting URLs passed from the BlackBerry device to the MiCollab Client

Service.

Corrective Action

Execute the following commands on the

Remote Proxy Services server (not the

MiCollab Client Service) to resolve this issue:

1. Open a secure shell session (for example, using PuTTY) to the Remote Proxy Services server, logging in as root.

2. Type the following command on a single line and then press Enter at the end of the command:

db proxyapps setprop uca

ForceTrailingSlash no

This command modifies the Remote Proxy

Server configuration.

3. Type the following command on a single line and then press Enter at the end of the command:

signal-event proxyrules-update

This command applies the configuration changes.

191

MiCollab Client Administrator Guide

MiCollab for Mobile for BlackBerry secure connections

The Use Secure Connection option is presented in the Setup Wizard after users download and install the MiCollab for Mobile for BlackBerry. It is also available from the Account Options screen.

To configure a secure connection to the MiCollab Client Service from a BlackBerry mobile device, users are required to know the key store password on their device to accept the MiCollab Client

Service SSL certificate.

To configure a secure connection to the MiCollab Client Service:

From the BlackBerry mobile device, enable the Use Secure Connection option from one of the following in the MiCollab for Mobile for BlackBerry:

• Setup wizard

• Account Options screen

A dialog box appears prompting you to confirm that you want to configure a secure connection.

Select Yes.

Select Test Connection. The client application attempts to connect to the server using a secure connection. A dialog box informs you that the server's certificate is not trusted.

Select Trust Certificate. If you have never created a password for the key store on your device,

you are prompted to enter one. If you have created a password for the key store, skip to step 6 .

Enter a key store password in the two boxes, and then select OK.

When prompted, enter your key store password to allow the client application access to your

Handheld Key Store.

Note:

Use a password that you will not forget. Entering an incorrect password 10 times will delete all personal data from the device and restore it to a default state.

When prompted, select OK to allow the client application access to your Trusted Key Store.

Note:

A dialog box may appear indicating that the certificate could not be added to the Trusted Key

Store. Select OK to dismiss the dialog box.

The Connection Successful message appears.

Press the BlackBerry End/Power key to return to the device's home page screen.

At this point, the MiCollab Client Service’s SSL certificate is in the device’s key store. However, you must complete the following procedure to configure the certificate as trusted.

To configure the MiCollab Client Service's SSL certificate as trusted:

Navigate to the BlackBerry device Options screen and select Security Options.

Select Certificates from the Security Options menu.

From the Certificates screen, scroll down the page to locate the MiCollab Client Service certificate, as indicated by the MiCollab Client Service Fully Qualified Domain Name (FQDN). The

192

Troubleshooting

MiCollab Client Service certificate will have a red X next to the FQDN indicating that the certificate is not trusted.

Highlight the MiCollab Client Service certificate and press the BlackBerry Menu key.

Select Trust.

If you are prompted for your key store password again, enter it and select OK.

Return to the MiCollab for Mobile for BlackBerry application.

Exit the application and save the changes.

Open the application and go to the MiCollab for Mobile home screen.

10. Press the BlackBerry menu button, and then select Update Status.

Note:

Entering an incorrect password 10 times will delete all personal data from the device and restore it to a default state.

Access point name settings

In order for the chat functionality to work properly on the MiCollab for Mobile for BlackBerry application, you must ensure that the Access Point Name (APN) is set appropriately for your

BlackBerry operating system.

For more information and instructions for setting these properly, see http://btsc.webapps.blackberry.com/btsc/search.do?cmd=displayKC&docType=kc&externalId=KB

05327 .

Transport layer security settings

In order for the chat functionality to work properly on the MiCollab for Mobile for BlackBerry application, you must ensure that the Transport Layer Security (TLS) settings are correct for your

BlackBerry operating system. Perform ONE of the following procedures:

Set the Allow Untrusted HTTPS Connections and Allow Untrusted TLS Connections to

True.

• For BlackBerry® Enterprise Server 4.1 or later, in BlackBerry Manager, select the Black-

Berry® Mobile Data System Connection Service that is being used by the BlackBerry Client, and click Edit Properties.

• For BlackBerry Enterprise Server 4.0 or earlier, in BlackBerry Manager, select the BlackBerry

MDS that is being used by the BlackBerry Client, and click Edit Properties.

In the Properties column, click TLS/HTTPS and change the Allow untrusted HTTPS and

Allow untrusted TLS connections settings to True.

Click Apply, and then click OK.

193

MiCollab Client Administrator Guide

Restart the BlackBerry MDS or BlackBerry MDS Connection Service.

Note:

Restarting certain BlackBerry Enterprise Server services delays e-mail message delivery to

BlackBerry devices.

On the BlackBerry device, set the TLS Default option from Proxy to Handheld.

For BlackBerry® Device Software 4.0 to 4.7.x

On the Home screen of the device, click Options > Security > TLS.

Click TLS default and select Handheld.

Click Prompt For Server Trust and select No.

Click Prompt If Client Cert Not Found and select No.

Display the menu and select Save.

For BlackBerry Device Software 5.0

From the Home screen of the device, click Options > Security Options > Advanced Security

Options.

Choose TLS and then set the TLS Default to Handheld.

Set Prompt For Server Trust to No.

Set Prompt If Client Cert Not Found to No.

Display the menu and select Save.

For BlackBerry Device Software 6.0

From the Home screen of the device, click Options > Security > Advanced Security Settings.

Choose TLS.

In the Proxy TLS section, set Enabled turned off (this means that handheld settings are used).

Display the menu and select Save.

194

Troubleshooting

MiCollab Client for VMware Horizon View troubleshooting

Table 46 MiCollab Client for VMware Horizon View problems

describes troubleshooting procedures for issues that can arise when installing, configuring, and running MiCollab Client for VMware Horizon

View.

Table 46: MiCollab Client for VMware Horizon View problems

Issue Probable Cause Corrective Action

No audio or poor audio after connecting a USB headset.

No audio or poor audio after connecting any type of headset.

Poor audio after connecting any type of headset.

Unable to select Headset in the

MiCollab Desktop Client

Configuration/Softphone settings

The headset is selected for USB redirection.

RDP protocol is enabled for the virtual desktop.

Ensure that the headset is not enabled for USB redirection.

Ensure PCoIP protocol is enabled.

Thin Client operating in Wireless mode.

Ensure Thin Client is operating in

LAN Mode.

The Thin / Thick Client physical endpoint does not have Headset set as the default Sound device.

Select Headset as the default

Sound device on the physical endpoint device.

195

MiCollab Client Administrator Guide

MiCollab Audio, Web and Video Conferencing collaboration troubleshooting

Table 47 MiCollab Audio, Web and Video Conferencing Collaboration problems

provides MiCollab

Audio, Web and Video Conferencing errors and their possible causes. After the user accesses the

MiCollab Audio, Web and Video Conferencing Web pages, he or she can access troubleshooting information from the MiCollab Audio, Web and Video Conferencing online help.

196

Troubleshooting

Table 47: MiCollab Audio, Web and Video Conferencing Collaboration problems

Problem or Error

Users cannot create or view conferences.

Possible Cause

The MiCollab Audio, Web and

Video Conferencing URL is not configured correctly on the

MiCollab Client Service

Administrator interface.

Corrective Action

Determine the correct hostname of the

MiCollab Audio, Web and Video

Conferencing server and configure the

URL on the Collaboration Server Details page in the MiCollab Client Service

Administration interface.

To test the URL:

1. From the MiCollab Client Service

Administrator interface, click the

Collaboration tab.

2. Copy the URL configured for the collaboration server.

3. Paste the URL in a Web browser. The browser should show a page with links to the MiCollab Audio, Web and Video

Conferencing User Portal and Server

Manager.

In most cases, the MiCollab Audio, Web and Video Conferencing URL should be of the form http://<awc-server-hostname>.

The URL may also be https.

The MiCollab Audio, Web and

Video Conferencing hostname is not resolvable from the MiCollab

Client Service or the address is unreachable.

You have configured the wrong type of collaboration server for the enterprise in the MiCollab Client

Service Administrator interface.

Verify that the nameserver specified in

Server Manager for the MiCollab Client

Service contains an entry for the specified

MiCollab Audio, Web and Video

Conferencing server. You may need to specify that DNS resolution should be performed using “Corporate DNS servers” in the Manage domains page in Server

Manager. See the MSL documentation for more information.

To configure MiCollab Audio, Web and

Video Conferencing as the collaboration server:

1. From the MiCollab Client Service

Administrator interface, click the

Enterprise tab.

2. Review the setting for the

Collaboration server type field. If it is not configured as Mitel Audio and Web

Conferencing, delete the enterprise and then re-create it using MiCollab Audio,

Web and Video Conferencing as the collaboration server.

Page 1 of 3

197

MiCollab Client Administrator Guide

Table 47: MiCollab Audio, Web and Video Conferencing Collaboration problems (continued)

Problem or Error

The user says that the

Collaboration menu is not available from the MiCollab

Desktop Client.

Possible Cause

The user is not licensed for the

Collaboration feature.

Corrective Action

To enable the Collaboration feature for the user:

1. From the MiCollab Client Service

Administrator interface, click the

Accounts tab.

2. Locate the user and click the link to open the Account Details page for the user.

3. Under Licensed Features, enable the

Collaboration feature for the user.

4. Instruct the user to restart the MiCollab

Desktop Client. The Collaboration menu is available.

When the account was created, the

Default Account Settings on the

Enterprise tab did not specify a collaboration server.

To determine the Default Account Settings collaboration server setting:

1. From the MiCollab Client Service

Administrator interface, click the

Enterprise tab.

2. Under Default Account Settings, if the collaboration server is set to [None], then none of the accounts created in the enterprise will have collaboration server specified.

To specify a collaboration server for an account:

3. From the MiCollab Client Service

Administrator interface, click the

Accounts tab.

4. Locate the user and click the link to open the Account Details page for the user.

5. Under Account Settings, select the appropriate server for the Collaboration server field.

6. Instruct the user to restart the MiCollab

Desktop Client. The Collaboration menu is available.

Page 2 of 3

198

Troubleshooting

Table 47: MiCollab Audio, Web and Video Conferencing Collaboration problems (continued)

Problem or Error

The user cannot join a Web conference or Audio and Web conference as the host or leader when initiating a conference from the MiCollab

Desktop Client.

Possible Cause

The user did not enter his or her e-mail address when joining the conference.

Corrective Action

When the user starts a Web or Audio and

Web conference from the MiCollab

Desktop Client, a Web browser opens to the MiCollab Audio, Web and Video

Conferencing Join page.

To join the conference as a participant, the user can type his or her name in the box

(for example, Sally) and clicks Join.

To join the conference as the host, the user must type his or her e-mail address in the box (for example,

[email protected]) and clicks Join.

Users running MiCollab

Desktop Client Release 7.0 or earlier client are unable to upgrade the MiCollab AWV client to Release 7.1

User is attempting to upgrade the

MiCollab AWV client to Release 7.1 from a MiCollab Desktop Client

Release 7.0 or earlier client. This upgrade path is not supported.

User should upgrade to MiCollab Client

Release 7.1 first, then perform the AWV client upgrade.

User should upgrade the AWV client from the AWV portal or through the AWV

Desktop Client Launcher.

Page 3 of 3

199

MiCollab Client Administrator Guide

200

The Mitel word and logo are trademarks of Mitel Networks Corporation.

Any reference to third party trademarks are for reference only and Mitel makes no representation of ownership of these marks.

Key features

Call control
Contact management
Dynamic Status
Collaboration
Installation and configuration
Maintenance
Troubleshooting

Frequently asked questions

MiCollab Client is a software-based solution that simplifies and enhances business communications, combining call control features from Mitel communication platforms with collaboration tools such as contact management, Dynamic Status, and instant messaging.

You can configure and manage MiCollab Client using the MiCollab Client Service.

You can access MiCollab Client features from the MiCollab Desktop Client, MiCollab MAC Desktop Client, MiVoice for Skype for Business, MiCollab Web Client, MiCollab for Mobile, Android, BlackBerry, iPhone, and Windows Phone.