Quest® Unified Communications Analytics 8.

5
Deployment Guide
© 2018 Quest Software Inc.
ALL RIGHTS RESERVED.
This guide contains proprietary information protected by copyright. The software described in this guide is furnished under a
software license or nondisclosure agreement. This software may be used or copied only in accordance with the terms of the
applicable agreement. No part of this guide may be reproduced or transmitted in any form or by any means, electronic or
mechanical, including photocopying and recording for any purpose other than the purchaser’s personal use without the written
permission of Quest Software Inc.
The information in this document is provided in connection with Quest Software products. No license, express or implied, by
estoppel or otherwise, to any intellectual property right is granted by this document or in connection with the sale of Quest
Software products. EXCEPT AS SET FORTH IN THE TERMS AND CONDITIONS AS SPECIFIED IN THE LICENSE
AGREEMENT FOR THIS PRODUCT, QUEST SOFTWARE ASSUMES NO LIABILITY WHATSOEVER AND DISCLAIMS ANY
EXPRESS, IMPLIED OR STATUTORY WARRANTY RELATING TO ITS PRODUCTS INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT. IN NO
EVENT SHALL QUEST SOFTWARE BE LIABLE FOR ANY DIRECT, INDIRECT, CONSEQUENTIAL, PUNITIVE, SPECIAL OR
INCIDENTAL DAMAGES (INCLUDING, WITHOUT LIMITATION, DAMAGES FOR LOSS OF PROFITS, BUSINESS
INTERRUPTION OR LOSS OF INFORMATION) ARISING OUT OF THE USE OR INABILITY TO USE THIS DOCUMENT, EVEN
IF QUEST SOFTWARE HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. Quest Software makes no
representations or warranties with respect to the accuracy or completeness of the contents of this document and reserves the
right to make changes to specifications and product descriptions at any time without notice. Quest Software does not make any
commitment to update the information contained in this document.
If you have any questions regarding your potential use of this material, contact:
Quest Software Inc.
Attn: LEGAL Dept.
4 Polaris Way
Aliso Viejo, CA 92656
Refer to our website (www.quest.com) for regional and international office information.
Patents
Quest Software is proud of our advanced technology. Patents and pending patents may apply to this product. For the most current
information about applicable patents for this product, please visit our website at www.quest.com/legal.
Trademarks
Quest and the Quest logo are trademarks and registered trademarks of Quest Software Inc. in the U.S.A. and other countries. For
a complete list of Quest Software trademarks, please visit our website at www.quest.com/legal. Microsoft, Active Directory,
ActiveSync, Excel, Lync, and Skype are either registered trademarks or trademarks of Microsoft Corporation in the United States
and/or other countries. Cisco and the Cisco logo are trademarks or registered trademarks of Cisco and/or its affiliates in the U.S.
and other countries. All other trademarks, servicemarks, registered trademarks, and registered servicemarks are the property of
their respective owners.

Legend

CAUTION: A CAUTION icon indicates potential damage to hardware or loss of data if instructions are not followed.

IMPORTANT NOTE, NOTE, TIP, MOBILE, or VIDEO: An information icon indicates supporting information.

UC Analytics Deployment Guide

Updated - June 2018
Software Version - 8.5
Contents

Prerequisites for your installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Supported environments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Supported browsers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Architecture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
About the web site . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
About the Data Engine service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
About the Query Engine service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
About the Storage Engine service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Deployment options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Hardware minimum requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
About NAS/SAN support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Suggested hardware configurations for different size environments . . . . . . . . . . . . . . . . 13
Software prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Prerequisites for the UC Analytics services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Web site prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Planning for deployment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Determining where to install services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
What files should be excluded from anti-virus software? . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
What files need to communicate through software firewalls? . . . . . . . . . . . . . . . . . . . . . . . . 18
About UC Analytics configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

Installing UC Analytics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Types of installations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Upgrading from 8.1 or later . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Considerations before you install . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
About a pilot installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
About a production installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Rules when performing a distributed installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Accounts used during installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Performing a pilot installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Performing a production installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Installing additional Storage Engine services after installation . . . . . . . . . . . . . . . . . . . . 26
Installing additional collector roles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Activating the UC Analytics license . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Setting up the web site for HTTPS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

Configuring UC Analytics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
About administration settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
How do I set a user to be a product administrator? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
About multi-tenant environments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Configuration process overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Modifying the initial target environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

Unified Communications Analytics 8.5 Deployment Guide

3
Contents
 About the authentication credential . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Adding multiple Active Directory forests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Configuring UC Analytics for resource forests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Adding target environments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Configuring data sources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Resource forest configuration process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Adding a target environment for native Office 365 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Setting the time period for retaining data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Setting the start date for data collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Adding and configuring data sources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Adding more than one instance of the same data source . . . . . . . . . . . . . . . . . . . . . . . . 38
Specifying explicit domain controllers for LDAP connections . . . . . . . . . . . . . . . . . . . . . 38
Recommendations for collecting from Office 365 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
When would I use the Delete Data option? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
How often do collections update the data? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Updated each time collection is run . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Once a day “snapshot” collections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Data sources that run in background as needed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Viewing the collection job status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Copying the job details information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Filtering job status results by state or type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Filtering job status results by date range . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Forcing a data source collection to run now . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Renaming a data source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Identifying your internal domains . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Guidelines when specifying domains . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Classifying domains for message traffic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Granting full access to Admin Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Adding a tenant administrator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Granting users access to data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
About target environments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
To grant access to specific types of data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Differences between aggregate and unrestricted access . . . . . . . . . . . . . . . . . . . . . . . . 49
Accessing the UC Analytics web site . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Changing your formats for date, time, and digit separators . . . . . . . . . . . . . . . . . . . . . . 50
Overriding the time zone offset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51

Adding data sources for Active Directory or Azure Active Directory . . . . . . . . . . . . . . . 52

Adding data sources for different target environments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Permissions needed to collect Active Directory data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Permissions needed for the Domain Controller data source . . . . . . . . . . . . . . . . . . . . . . 53
Permissions needed for the Office 365 user subscription configuration data source . . . 53
Adding data sources for Active Directory / Office 365 (hybrid) . . . . . . . . . . . . . . . . . . . . . . . 53
Creating an Domain Controller data source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
Creating a data source for Office 365 user subscription configuration . . . . . . . . . . . . . . 55
Adding data sources for native Office 365 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56

Unified Communications Analytics 8.5 Deployment Guide

4
Contents
Adding data sources, chargeback costs, and thresholds for Exchange
and Exchange Online . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
Permissions needed to collect Exchange on-premise or hybrid data . . . . . . . . . . . . . . . . . . 58
Permissions needed for the Exchange configuration data source . . . . . . . . . . . . . . . . . 59
Permissions needed for the Exchange tracking logs data source . . . . . . . . . . . . . . . . . 59
Permissions needed for Exchange mailbox contents or Exchange mailbox content
summary data sources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
Permissions needed for the Exchange IIS logs (ActiveSync and OWA) data source . . . 60
Permissions needed for the Exchange public folders data source . . . . . . . . . . . . . . . . . 61
Permissions needed for the Exchange Online hybrid user configuration data source . . 61
Permissions needed for the Exchange Online
hybrid mailbox configuration data source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
Permissions needed for Exchange Online mailbox contents data . . . . . . . . . . . . . . . . . 62
Permissions needed for Exchange Online mailbox content summary data . . . . . . . . . . 62
Permissions needed to collect from native Exchange Online . . . . . . . . . . . . . . . . . . . . . . . . 63
Permissions needed for Exchange Online native user configuration data source . . . . . 63
Permissions needed for Exchange Online native mailbox configuration . . . . . . . . . . . . 63
Creating a data source for Exchange configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
Why should I specify target mailboxes? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
Best practices for gathering performance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
Using dynamic distribution groups to select target mailboxes . . . . . . . . . . . . . . . . . . . . 66
What types of mailboxes are excluded? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
Can I enter the Domain Users group as the target for the data collection? . . . . . . . . . . 67
Troubleshooting the Exchange configuration collection . . . . . . . . . . . . . . . . . . . . . . . . . 67
Creating a data source for Exchange tracking logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
About collecting historical tracking logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
Creating a data source for Exchange mailbox contents . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
Tips for better performance for mailbox contents collection . . . . . . . . . . . . . . . . . . . . . . 71
Do I need both Exchange tracking log and Exchange mailbox contents collections? . . . . . . 72
Creating a data source for Exchange IIS Logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
About the IIS log file locations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
Creating a data source for Exchange mailbox content summary . . . . . . . . . . . . . . . . . . . . . 74
Creating a data source for Exchange public folders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
Adding Exchange Online hybrid data sources for hybrid Office 365 . . . . . . . . . . . . . . . . . . . 77
About AD synchronization methods for hybrid Exchange Online . . . . . . . . . . . . . . . . . . 77
Creating a data source for Exchange Online hybrid user configuration . . . . . . . . . . . . . 78
Creating a data source for Exchange Online hybrid mailbox configuration . . . . . . . . . . 79
Adding Exchange Online data sources for native Office 365 . . . . . . . . . . . . . . . . . . . . . . . . 81
Creating a data source for Exchange Online native user configuration . . . . . . . . . . . . . 81
Creating a data source for the Exchange Online
native mailbox configuration data source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
Creating a data source for Exchange Online mailbox contents data source . . . . . . . . . . 83
Creating a data source for Exchange Online mailbox content summary data source . . . 84
Setting chargeback costs for Exchange . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
Setting thresholds for Exchange metrics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
Omitting words when filtering by subject or body . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88

Unified Communications Analytics 8.5 Deployment Guide

5
Contents
Adding data sources, chargeback costs, and thresholds for Skype for
Business/Lync . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
Permissions needed to collect Skype for Business/Lync data . . . . . . . . . . . . . . . . . . . . . . . . 89
Permissions needed for Skype for Business/Lync configuration data source . . . . . . . . . 89
Permissions needed for Skype for Business/Lync CDR data source . . . . . . . . . . . . . . . 90
Permissions needed for Skype for Business/Lync QoE data source . . . . . . . . . . . . . . . 90
Creating a data source for Skype for Business/Lync configuration . . . . . . . . . . . . . . . . . . . . 90
Creating a data source for Skype for Business/Lync CDR . . . . . . . . . . . . . . . . . . . . . . . . . . 92
Creating a data source for Skype for Business/Lync QoE . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
Setting call classifications for Skype for Business/Lync . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
About specifying Enterprise Voice call classifications . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
Setting chargeback costs for Skype for Business/Lync . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
Setting thresholds for Skype for Business/Lync metrics . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
About the default Skype for Business/Lync quality metrics . . . . . . . . . . . . . . . . . . . . . . . 96
Adding new threshold classifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98

Adding data sources, chargeback, and thresholds for Cisco . . . . . . . . . . . . . . . . . . . . 100

Permissions needed to collect Cisco data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
Permissions needed for the Cisco configuration data source . . . . . . . . . . . . . . . . . . . . 100
Permissions needed for the Cisco CDR logs data source . . . . . . . . . . . . . . . . . . . . . . 101
Creating a data source for Cisco configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
Creating a data source for Cisco CDR logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
Setting call classifications for Cisco . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
About specifying Cisco call classifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
Setting chargeback costs for Cisco . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
Setting thresholds for Cisco metrics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104

Managing which insights can seen by users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105

Enabling a Company Home Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
Setting insight visibility settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
How is insight visibility different from data access? . . . . . . . . . . . . . . . . . . . . . . . . . . . 106

Configuring and managing subscriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107

What are insight subscriptions? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
Configuring settings for subscriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
Managing user subscriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109

Making changes to your deployment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111

Options available in the Deployment Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
Deploying additional Storage Engines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
Deploying additional collectors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
Using the Tools menu for support activities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114

Appendix A:
Configuring Impersonation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
Setting impersonation for Exchange 2013 or Exchange 2016 . . . . . . . . . . . . . . . . . . . . . . 115
Setting impersonation for Office 365 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116

Unified Communications Analytics 8.5 Deployment Guide

6
Contents
Appendix B:
Configuring the Skype for Business or Lync Server . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
Configuring Lync Server 2010 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
1. Adding the SQL store for monitoring . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
2. Installing the Monitoring role . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
3. Enabling Call Detail Recording (CDR) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
4. Starting the monitoring services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
Configuring Lync Server 2013 or Skype for Business 2015 . . . . . . . . . . . . . . . . . . . . . . . . 118
Prerequisite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
1. Associating the store with the Front-End pool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
2. Updating the Lync or Skype for Business Server . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
3. Enabling and configuring monitoring . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
4. Starting the monitoring services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120

Appendix C:
Configuring IIS Log Files to capture ActiveSync or OWA events . . . . . . . . . . . . . . . . . 121
Configuring IIS Logging on the Exchange CAS and Mailbox servers . . . . . . . . . . . . . . . . . 121
Configuring IIS if Exchange is hosted on Windows 2003 Server . . . . . . . . . . . . . . . . . 121
Configuring IIS Logging if Exchange is hosted on Windows Server 2008 or later . . . . 123
What ActiveSync events are collected and displayed in the insights? . . . . . . . . . . . . . . . . 124

Appendix D:
PowerShell cmdlets used by data sources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
Exchange configuration data source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
Exchange public folder data source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
Skype for Business/Lync configuration data source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
Exchange Online hybrid and native user configuration data sources . . . . . . . . . . . . . . . . . 127
Exchange Online hybrid and native mailbox configuration data sources . . . . . . . . . . . . . . 128
Exchange Online mailbox contents data source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
Office 365 user subscription configuration data source . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128

Appendix E:
Custom configurations and backup and recovery options . . . . . . . . . . . . . . . . . . . . . . 129
Setting up a multi-forest environment with a one-way trust . . . . . . . . . . . . . . . . . . . . . . . . . 129
Firewall configuration: ports for data collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
Ports used for service-to-service communication in a distributed installation . . . . . . . . 130
Backing up and restoring your data using scripts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
Supported scenarios . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
About the backup and restore batch files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
Step 1: Edit the backup.bat file parameters for your installation . . . . . . . . . . . . . . . . . . 132
Step 2: Run the backup batch file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
Step 3: Edit the restore batch file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
Step 4a: Restore the storage data in an existing installation . . . . . . . . . . . . . . . . . . . . 134
Step 4b: Restore the storage data to a new installation . . . . . . . . . . . . . . . . . . . . . . . . 135
Scheduling the backup batch file to run automatically . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
Performing a manual backup of the storage folder before upgrade . . . . . . . . . . . . . . . . . . 136
Moving your storage location . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
Recommendations for disaster recovery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137

Unified Communications Analytics 8.5 Deployment Guide

7
Contents
Setting a custom title page for exported or subscription insights . . . . . . . . . . . . . . . . . . . . . 138
Changing the interval time before job status is purged . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
Configuring remote PowerShell to use the required proxy settings . . . . . . . . . . . . . . . . . . . 140
Overriding PowerShell credential winnowing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141

Appendix F:
Questions and answers about data source configuration . . . . . . . . . . . . . . . . . . . . . . 142
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142
How often do the data collections actually gather data and when do they run? . . . . . . 142
Why did an insight show no data for a 30-day range though I initially set the data
source to collect 30 days back? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
If I collect both Exchange Tracking Logs and
Exchange Mailbox Contents, are there duplicate items? . . . . . . . . . . . . . . . . . . . . . . . 144
If I collect message data only from the Exchange tracking logs, is the message
Send Date and delivery time available? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145
What are the differences between the Exchange
Mailbox Contents and Exchange Tracking Logs data sources? . . . . . . . . . . . . . . . . . . 145
Why do I get an error when collecting Exchange
configuration from multiple Exchange versions? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
Why do I have to specify domain name when doing a multi-forest collection? . . . . . . . 147

About us . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148
We are more than just a name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148
Our brand, our vision. Together. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148
Contacting Quest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148
Technical support resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148

Unified Communications Analytics 8.5 Deployment Guide

8
Contents
 1
Prerequisites for your installation
• Overview
• Supported environments
• Architecture
• Deployment options
• Hardware minimum requirements
• Software prerequisites
• Planning for deployment
• Determining where to install services
• What files should be excluded from anti-virus software?
• What files need to communicate through software firewalls?
• About UC Analytics configuration

Overview
Quest Unified Communications Analytics provides dynamic and up-to-date analytics about your Exchange on-
premise messaging environments, about your Skype for Business and Lync on-premise environments, about your
Cisco environments, and about Office 365 Exchange Online hybrid or native environments. UC Analytics unlocks
the business intelligence in your corporate messaging system to enable better business decisions.
Predefined insights provide a simple way to view Exchange messaging volumes and details between individuals,
groups, and external entities, and to see peer-to-peer session and conference information for Skype for
Business/Lync or Cisco. You can also view the quality of experience (QoE) information about all Skype for
Business or Lync enterprise voice calls, conferences, and peer-to-peer sessions.
You can select predefined insights from the insight library and add them to your personal dashboard.
Once UC Analytics is installed, access the UC Analytics home page, at the following location:
http://<ServerName>/Analytics/

Supported environments
You can use UC Analytics to collect data from the following environments:
• Microsoft Exchange 2010 (SP1 and later)
• Microsoft Exchange 2013
• Microsoft Exchange 2016
• Exchange Online (Office 365 hybrid with on-premise Exchange)
• Exchange Online (Office 365 native)

Unified Communications Analytics 8.5 Deployment Guide

8
Prerequisites for your installation
 • Microsoft Lync 2010
• Microsoft Lync 2013
• Microsoft Skype for Business 2015
• Cisco Unified Communications Manager (CUCM) 10.5(2) and later with Active Directory integration

Supported browsers
Once you have installed UC Analytics, you can access the web site from anywhere using one of the following
browsers:
• Microsoft Edge
• Internet Explorer 10 or later
• Mozilla Firefox
• Google Chrome
• Apple Safari
Since UC Analytics uses Windows Integrated Authentication to connect to the web site, if you are on a different
domain than the web site or are using an iPad, you will be prompted for your user name and password when you
connect to the web site.

Architecture
The following are the main services that comprise UC Analytics:
• Web site (IIS)
• UC Analytics Data Engine
• UC Analytics Query Engine
• UC Analytics Storage Engine
You can install all the services on a single computer or distribute the services across two or more computers. For a
distributed installation, the Data Engine and the Query Engine services can be divided into two different roles:
• collector role
• insights role

About the web site

All user interaction with the product is done through the UC Analytics web site. You configure your target
environments and create your data collections through the web site using the Admin Settings. You also create data
classifications and grant users access to specific types of data using the Admin Settings.
You view the collected data through insights and use filters to customize insights to include only the data that you
want. You can also export insights and set up subscriptions to automatically export and email specific insights on a
regular schedule.

Unified Communications Analytics 8.5 Deployment Guide

9
Prerequisites for your installation
About the Data Engine service
The Data Engine contains all the business logic for the product. It determines how UC Analytics stores data and
performs the data collections. The Data Engine includes the custom logic used for insights, licensing, tiles; in
short, all the logic that defines UC Analytics as a product.
The Data Engine can be split into two roles:
• collector role
• insights role
The collector role is responsible for all the data collections from your environments such as Active Directory,
Exchange and Exchange Online, Skype for Business, Lync, and Cisco. It contains the logic associated with
retrieving the data.
The insights role is involved with the user interactions with the web site such as launching insights and entering
configuration settings.
You can install more than one instance of the Data Engine (Collector) to distribute the data collection load. When
you configure a data source to collect data, you have the option to set the specific Data Engine (Collector) that
should be used for that data source.

About the Query Engine service

The Query Engine processes all the data that is stored by the Storage Engine. Processing activities can include
finding data, counting data values, and aggregating data.
The Query Engine can be split into two roles:
• collector role
• insights role
The collector role is responsible for storing data to the Storage Engine, storing it efficiently and merging it with
existing stored data. The collector role can be a heavy user of resources such as RAM. For larger environments,
spikes in collector role activity could affect the responsiveness of insights if both the collector role and insights role
are installed on the same computer.
The insights role is responsible for interacting with the Data Engine (Insights) to handle user activity with the web
site such as launching insights and setting configuration. The insights role can also be a heavy user of RAM.
You can install more than one instance of the Query Engine (Collector) to distribute the load of writing the data to
storage. If you are distributing the Query Engine (Collector), it is recommended you install a Data Engine
(Collector) on the same server, and that a Storage Engine also be installed on that server.

About the Storage Engine service

The Storage Engine is the repository for all the data that you collect and for the settings that you specified when
you configured the product. You can install multiple storage engine services to distribute the data storage load
across several computers. If you install multiple Storage Engines, the data set is divided across the Storage
Engines. There is no redundancy since only one copy of a specific piece of data is stored.

Information stored by the Storage Engine

Data is gathered from a variety of sources. You create data source collections to gather data from Active Directory,
from Exchange mailboxes through EWS (Exchange Web Services) and from Exchange tracking logs.
You can also collect from Exchange ActiveSync logs, from Exchange Online through PowerShell, from Skype for
Business/Lync CDR and QoE databases, and from Cisco Unified Communications Manager server and from
Cisco CDR logs.

Unified Communications Analytics 8.5 Deployment Guide

10
Prerequisites for your installation
The Storage Engine service is used to store the collected information:
• User, group, and Data Loss Prevention (DLP) policy information from Active Directory.
• Configuration including organization, server, DAG, database status, database copy, mobile device
configuration, personal archive and mailbox statistics from the Exchange server.
• Message traffic information gathered from Exchange message tracking logs.
• Message information gathered through EWS (Exchange Web Services).
• Data Loss Prevention (DLP) policy rule matches collected from Exchange message tracking logs.
• Mobile device information from Exchange IIS ActiveSync logs.
• Public folder information for legacy public folders (Exchange 2010) and new public folders (Exchange 2013
and later).
• Exchange Online mailbox statistics such as mailbox size, permissions, and mobile devices from hybrid (on-
premise and Office 365) and from native Office 365 environments.
• Exchange Online user and group configuration, and mailbox content collected from a native Office 365
deployment.
• Office 365 user subscription configuration information including licenses and subscribed services such as
Exchange Online, Skype for Business Online, and SharePoint Online.
• Server, pool, and user policy configuration data from the Skype for Business/Lync server
• Peer-to-peer session and conference data collected from the Skype for Business/Lync Call Detail
Recording (CDR) database.
• QoE (Quality of Experience) information from the Skype for Business/Lync QoE database.
• Configuration end-user data from the Cisco Unified Communications Manager (Call Manager) server and
user data from Active Directory.
• Peer-to-peer and conference data collected from the Cisco Call Detail Recording (CDR) log files.

Unified Communications Analytics 8.5 Deployment Guide

11
Prerequisites for your installation
Figure 1. UC Analytics services and relationships to your on-premise environments.

UC Analytics
web site

Office 365

Data Engine Service

Insights role
Collector role

Cisco CUCM
Servers

Exchange and Active

Directory Servers

Query Engine Service

Insights role
Collector role

Storage Engine Services

 Configu ration database
 Data collection sto rage

Deployment options
There are two main options for installing UC Analytics:
• Pilot deployment—all services on a single computer, simple configuration.
• Production deployment—services can be distributed across several computers:
▪ Web site & Data Engine (Insights)
▪ Data Engine (Collector)
You can install more than one instance of the Data Engine (Collector).
▪ Query Engine (Collector)
You can install more than one instance of the Query Engine (Collector).

Unified Communications Analytics 8.5 Deployment Guide

12
Prerequisites for your installation
 ▪ Query Engine (Insights)
▪ Storage Engine service.
You can install more than one instance of the Storage Engine.
If you install additional collector roles (Data Engine service and Query Engine service), it is recommended that you
have both service collector roles on the same server.
If you install multiple Storage Engines, the data set is divided across the Storage Engines. There is no redundancy
since only one copy of a specific piece of data is stored; no multiple copies of data are stored.
You install the Data Engine (Insights) and the web site on the same server for authentication reasons.

Hardware minimum requirements

If you are installing UC Analytics, the computer must meet the following minimum requirements:

Table 1. Minimum requirements for hardware.

Type Minimum
Processor Minimum: Quad-core 64-bit computer.
RAM Minimum: 24 GB.
Disk • 5 GB for the application
• X GB where X is the required disk space for collected data
For estimates regarding the required disk space for the collected data for different numbers
of users for all the platforms, see the UC Analytics Deployment Sizing.xlsx spreadsheet
which can be found under Documentation in the autorun.exe.

About NAS/SAN support

Generally, using a NAS/SAN device for the Storage Engine is not supported. UC Analytics might support specific
NAS/SAN devices but Quest would require full testing with the devices, or device simulators, to support them.
Since each NAS/SAN device, depending on manufacturer, is unique, Quest will work with NAS/SAN vendors to
certify or qualify a device but the NAS/SAN vendor must be willing to mutually assist. To engage a NAS/SAN
vendor and initiate the qualification process, you would send an email to your NAS/SAN vendor and contact Quest
Support.

Suggested hardware configurations for

different size environments
Generally you can install UC Analytics on a single computer. For some large installations, you might have a
distributed installation on two or more computers. The following examples show the estimated requirements for a
single server installation. The estimated requirements assume that you are collecting from all data sources,
including Exchange public folders and Exchange IIS Logs (ActiveSync events and OWA logons).

IMPORTANT: These estimates provided here are guidelines only. You might require more resources,
depending on your environment and how you configure UC Analytics. Foremost, if you collect email
message body, the required RAM and disk space will be greater than the estimates. If you configure many
data sources, the required resources can increase.

For distributed installations, you can use the UC Analytics Deployment Sizing.xlsx spreadsheet to see different
options that can meet your environment’s needs. The spreadsheet can be found under Documentation in the
autorun.exe.

Unified Communications Analytics 8.5 Deployment Guide

13
Prerequisites for your installation
Table 2. Sample minimum requirements.

Minimum
5,000 users 20,000 users 50,000 users 100,000 users
Requirements for
Minimum RAM 24 GB 36 GB 84 GB 144 GB
Disk Space 721 GB 2.9 TB 7.2 TB 14.4 TB
Processors Quad core Quad core Eight core Eight or 16 Core
Data retention 1 year 1 year 1 year 1 year

Example: Small single server installation

This example shows the suggested hardware requirements for a smaller deployment with all the service roles
installed on a single computer. The environment from which data is to be collected has the following
characteristics:
• # of AD users = 5000
• # of Exchange mailboxes = 5000
• # of Exchange public folders = 5000
• # of Skype/Lync users = 5000
• # of Cisco users = 5000
• Retention period = 365 days

Table 3. Shows the minimum requirements for a small single server installation.

Processor RAM Required Disk Space

Quad-core 64-bit Minimum: 24 GB 721 GB

Example: Medium single server installation

This example shows the suggested hardware requirements for a medium installation with all the service roles
installed on a single server. The environment from which data is to be collected has the following characteristics:
• # of AD users = 20000
• # of Exchange mailboxes = 20000
• # of Exchange public folders = 20000
• # of Skype/Lync users = 20000
• # of Cisco users = 20000
• Retention period = 365 days

Table 4. Shows the minimum requirements for a medium single server installation.

Processor RAM Required Disk Space

Quad-core 64-bit 36 GB 2.9 TB

Example: Larger single server installation

This example shows the suggested hardware requirements for a larger installation with all the service roles
installed on a single server. The environment from which data is to be collected has the following characteristics:
• # of AD users = 50000
• # of Exchange mailboxes = 50000

Unified Communications Analytics 8.5 Deployment Guide

14
Prerequisites for your installation
 • # of Exchange public folders = 50000
• # of Skype/Lync users = 50000
• # of Cisco users = 50000
• Retention period = 365 days

Table 5. Shows the minimum requirements for a larger single server installation.

Processor RAM Required Disk Space

Eight-core 64-bit 84 GB 7.2 TB

If you install the Storage Engine on a server with two disks, you should specify a directory on the non-operating
system drive as the Storage Directory for the Storage Engine during installation.

Software prerequisites
This section lists the prerequisites for the individual UC Analytics components (services and service roles). If you
want to install more than one component on a single server, you must ensure all the prerequisites for the
components are met.
The server on which UC Analytics is installed must meet following minimum requirements:

Table 6. Software requirements

Server Minimum Requirements

Operating Systems One of the following:
• Windows 7 (64 bit version) or later
• Windows Server 2008 R2 (Service Pack 1) or later
• Windows Server 2012 and later
• Windows Server 2016
Any server on which a UC Analytics service or service role is installed
must have a static IP address defined.
For a distributed deployment, the Remote Registry Service must be
running.

Prerequisites for the UC Analytics services

UC Analytics includes several services that are used to perform different activities. The following prerequisites
must be met to install the following services:
• Data Engine service
• Query Engine service
• Storage Engine service.

Unified Communications Analytics 8.5 Deployment Guide

15
Prerequisites for your installation
Table 7. Prerequisites for UC Analytics services.

Service Display Name Minimum Requirements

UC Analytics Data Engine service • Microsoft .NET Framework 4.6 (full version) or later
• PowerShell 3.0 or later
• To collect Office 365 user subscription data, the following software
prerequisites must be met:
▪ Microsoft Online Services Sign-in Assistant must be
installed.
▪ Windows Azure Active Directory Module for Windows
PowerShell version 1.x must be installed.
Also, since the Microsoft Azure AD cmdlets use the proxy settings for
Internet Explorer, ensure that the Internet Explorer proxy settings for the
service account are set correctly.
UC Analytics Query Engine service • 64-bit Java Runtime Environment (JRE) 1.8
UC Analytics Storage Engine service You can download the Java Runtime Environment (JRE) from the
following web site: http://java.com/en/download/manual.jsp.

Unified Communications Analytics 8.5 Deployment Guide

16
Prerequisites for your installation
Web site prerequisites
The Analytics web site requires IIS (Internet Information Services).
Under Internet Information Services (IIS), the World Wide Web Services must be installed. You install World Wide
Web Services using Windows Features and enable the required services.

Table 8. World Wide Web Services (IIS) services that must be enabled.

Web server (IIS) services Services that must be enabled

Application Development Features • ASP.NET
Enable both ASP.NET 3.5 and ASP.NET 4.5 if available.
• .NET Extensibility
• ISAPI Extension
• ISAPI Filters
Common HTTP Features Default Document
Static Content
HTTP Errors
Security Windows Authentication

Under Web Management Tools, the following service must be enabled:

Table 9. Web Management services that must be enabled.

Web Management tools Services that must be enabled

IIS 6 Management Compatibility IIS Metabase and IIS 6 configuration compatibility

For information about setting security for your UC Analytics web site, see Setting up the web site for HTTPS on
page 27.

Planning for deployment

When you are planning your deployment, you must determine the number of servers across which you are
deploying UC Analytics. You also must determine how much storage is required for the number of mailboxes from
which you are collecting data.
For additional information see the UC Analytics Deployment Sizing.xlsx spreadsheet which can be found under
Documentation in the autorun.exe.

Determining where to install services

It is not recommended that you install any UC Analytics services on the same server where core MessageStats or
UC Diagnostics is installed.
If you are installing the UC Analytics services on several computers, consider the following information:
• Data collection performance is better if the Data Engine service is located near to the Exchange server and
to the Skype/Lync CDR database server.
• Ideally, you would install UC Analytics on a computer that is in the same forest as the Exchange servers
from which you are collecting data. However, you can install in a forest that is separate from the forest that
contains your Exchange servers. For information about configuring multi-forest environments, see Adding
multiple Active Directory forests on page 31.

Unified Communications Analytics 8.5 Deployment Guide

17
Prerequisites for your installation
 • You can install UC Analytics on a virtual machine (VM) but, to obtain optimal performance for a production
installation, it is recommended that you install on a physical machine.
• The Storage Engine service nodes automatically synchronize with each other. If you install multiple Storage
Engine services, it is better to have them collocated when possible for performance reasons.
• It is best to have all the UC Analytics services located as close as possible. At a minimum they should all
be within the same site.
• For security considerations, all services are recommended to be installed within the intranet. For
information about configuring the web site for https, see Setting up the web site for HTTPS on page 27.
• For small to mid-size installations. UC Analytics can be installed on a single computer.
• For large installations, use one of the recommended deployments provided in the installer. For additional
information see the UC Analytics Deployment Sizing.xlsx spreadsheet which can be found under
Documentation in the autorun.exe.

What files should be excluded from

anti-virus software?
You should exclude the UC Analytics storage folder from anti-virus scans. By default, the storage directory is
located in the following path:
C:\Program Files\Quest\UC Analytics\Storage
If the storage folder is not excluded from anti-virus scans, the anti-virus software will lock files in the storage folder.
During normal operation, when your configured UC Analytics data collections attempt to update the stored data,
the file locks can cause problems. Also, if anti-virus scans are running against the storage folder, it can create
issues when the installer attempts to upgrade your stored data.

What files need to communicate

through software firewalls?
Software firewalls, such as Windows Firewall, can prevent the code in the UC Analytics processes from
performing necessary network input and output. Such firewalls must be configured to allow the UC Analytics Data
Engine to communicate with the Query Engine and to communicate with your Exchange, Active Directory, Cisco,
and Skype for Business resources.
The files that can be affected by a software firewall are as follows:
• C:\Program Files\Quest\UC Analytics\Storage Engine\bin\prunsrv.exe
• C:\Program Files\Quest\UC Analytics\Query Engine\bin\prunsrv.exe
• C:\Program Files\Quest\UC Analytics\Data Engine\UC.Analytics.Insights.DataEngine.Service.exe
• C:\Program Files\Quest\UC Analytics\Data Engine\UC.Analytics.Insights.DataEngine.BulkDataExport.exe
• C:\Program Files\Quest\UC Analytics\DeploymentManager.exe

Unified Communications Analytics 8.5 Deployment Guide

18
Prerequisites for your installation
About UC Analytics configuration
After you install UC Analytics, you must configure Admin Settings. You can access Admin Settings from the UC
Analytics home page located at:
http://<ServerName>/Analytics.

Click the gear icon on the home page side bar to access Admin Settings.
For more information, see Configuration process overview on page 29.

Unified Communications Analytics 8.5 Deployment Guide

19
Prerequisites for your installation
 2
Installing UC Analytics
• Types of installations
• Considerations before you install
• Accounts used during installation
• Performing a pilot installation
• Performing a production installation
• Installing additional Storage Engine services after installation
• Installing additional collector roles
• Setting up the web site for HTTPS

Types of installations
When you install UC Analytics, you can perform one of two types of installation:
• a pilot installation (single computer)
• a production installation (single computer or distributed)
For performance reasons, it is recommended that you do not install UC Analytics on the same computer as
MessageStats.
For information about the number of mailboxes from which you can collect data see Hardware minimum
requirements on page 13.
If you have a native Office 365 environment with no on-premise users, you can install UC Analytics in a workgroup.

Upgrading from 8.1 or later

When you are upgrading from UCCS - Analytics 8.1 or later, perform an in-place upgrade to ensure you maintain
your collected data. Do not uninstall the previous version. If you uninstall the previous version, you will lose all the
collected data.

NOTE: If you previously customized a data collection by modifying a .config file (usually with the help of
Quest Support), after you upgrade to a new version, check the same .config file and reapply all the changes.

Considerations before you install

The following limitations must be considered before you install UC Analytics:
• Do not install UC Analytics on the same server on which you have installed MessageStats.
• For evaluation scenarios, you can install UC Analytics on a virtual machine (VM). However, in a production
environment, a physical computer provides better performance.

Unified Communications Analytics 8.5 Deployment Guide

20
Installing UC Analytics
About a pilot installation
In a pilot installation, all the UC Analytics services are installed on a single computer. Though pilot installations are
typically used in test installations, if you have a computer with enough resources you could also use a pilot
installation for a production environment.
If you have a native Office 365 environment with no on-premise users, you can install UC Analytics in a workgroup.

About a production installation

In a production installation, you can distribute the UC Analytics services across several servers. Additionally, the
Data Engine service and the Query Engine service can be distributed in two separate roles, the insights role and
the collector role.
In a UC Analytics installation you can distribute the following services as follows:
▪ Web site & Data Engine (Insights)
▪ Data Engine (Collector)
You can install more than one instance of the Data Engine (Collector).
▪ Query Engine (Collector)
You can install more than one instance of the Query Engine (Collector).
▪ Query Engine (Insights)
▪ Storage Engine service.
You can install more than one instance of the Storage Engine.
For example, you might install the web site and the Data Engine (insights) and Query Engine (Insights) on one
server and the Data Engine (Collector) and Query Engine (Collector) on a second computer.
You can install multiple collector roles, Date Engine (Collector) and Query Engine (Collector), on different servers.
However, you can only install one instance of each insights role – Date Engine (Insights) and Query Engine
(Insights). By distributing the collector roles, you can distribute the data collection and data writing load for different
data sources.
The Storage Engine service is used to store the data collected from various platforms. To distribute the data that is
stored by the Storage Engine, you can install the Storage Engine on more than one server. It is better to have the
Storage Engines collocated when possible for performance reasons.
You could install instances of the Storage Engine service on both the servers and an additional Storage Engine on
a third server.

Table 10. Example of a distributed installation

Server1 Server2 Server3

Web Site &Data Engine (Insights) Data Engine (Collector) Data Engine (Collector)
Query Engine (Insights) Query Engine (Collector) Query Engine (Collector)
Storage Engine Storage Engine Storage Engine

IMPORTANT: Due to the volume of communication between the Data Engine and Query Engine, it is
recommended that these services be installed on the same server.

When you install more than one Data Engine (Collector), one of the collectors must be set as the Primary Data
Collector. By default the Primary Data Collector is the first collector that is installed. You can manually set a
collector to be the Primary Data Collector on the Add Server page when using the Advanced Deployment option.
The Primary Data Collector is used to run the data sources that run automatically in the background in addition to
the data sources that you have configured. For more information, see Data sources that run in background as
needed on page 40.

Unified Communications Analytics 8.5 Deployment Guide

21
Installing UC Analytics
For information about storage requirements, see Hardware minimum requirements on page 13.
You must ensure that the computer on which UC Analytics is to be installed meets the minimum software
requirements. For information about the minimum requirements, Software prerequisites on page 15.

Rules when performing a distributed

installation
Generally you select one of the recommended installations and specify the servers on which services are to be
installed. For larger, more complex environments, you can perform a production installation and specify the
location for each service or service role.
If you are performing a production installation, be aware of the following rules:
• You can install multiple instances of the Storage Engine and more than one instance of the Data Engine
(Collector) and Query Engine (Collector).
• You can install only one web site and only one instance of the Data Engine (Insights) and the Query Engine
(Insights).
• For authentication reasons, the web site and the Data Engine (Insights) are always installed on the same
computer.
• If you install the Data Engine (Collector) and Data Engine (Insights) on the same computer, you must also
install the Query Engine (Collector) and Query Engine (Insights) on one computer. UC Analytics does not
support having the Data Engine roles installed on single computer while the Query Engine roles are
installed on separate (multiple) computers.
• If you install the Data Engine (Collector) and Data Engine (Insights) on two different computers, you can
install the Query Engine (Collector) and Query Engine (Insights) on two different computers.

Accounts used during installation

The account that you use to install UC Analytics must be a local administrator on the computer. If you are
distributing the services, the account must have local administrator rights on each computer on which you are
installing.
During installation you can specify an account that is used to run the Data Engine service. This account must be a
domain account and must have local Admin rights on the computer on which the Data Engine service is installed.
By default, the account that is used to install UC Analytics is set as a product administrator, which means that the
account can access the Admin Settings which are used to configure the product.

IMPORTANT: It is not recommended that you use the built-in domain Administrator account for installing or
for accessing UC Analytics. If you have a child domain in your environment, or if you have two root level
domains, you will be unable to install the product or access the web site.

Unified Communications Analytics 8.5 Deployment Guide

22
Installing UC Analytics
Performing a pilot installation
A pilot installation installs all services on a single computer. All servers on which UC Analytics services are
installed must have a static IP address defined.

To perform a pilot installation of UC Analytics

1 Copy the UC Analytics.exe file to the computer on which you want to install and double-click the file.
- OR -
Double-click the autorun.exe file and select the Install tab.
2 Beside the heading for the UC Analytics Installer, click Install.
3 Select Pilot Install.
4 Enter information about the environment from which you want to gather data such as the number of Active
Directory users, Exchange mailboxes, Skype for Business/Lync users, and/or Cisco users and the time that
you want to retain the collected data.
The UC Analytics installer verifies the disk space and physical memory (RAM) on the selected server and
provides approximate estimated recommendations for your hardware configuration.
5 Enter the credentials that will be used to run the Data Engine service and click Next.
The account must be a domain account (not a local computer account) and must have local Admin rights to
the computer on which the Data Engine service is being installed.
6 Verify that the software prerequisites are met and click Next.
7 Specify the users who will be product administrators and have access to Admin Settings and click Next.
By default, the account used to install UC Analytics is added to the accounts that can access the Admin
Settings. You can add additional users by rerunning the installer and selecting to add additional product
administrators.
8 Accept the license agreement and install the product.
9 To access Admin Settings, open the UC Analytics web site:
http://<ServerName>/Analytics

10 Click the gear icon on the home page side bar.

Performing a production installation

When you perform a production installation, you can install different services on separate computers. You can run
the installer centrally and remotely deploy the different services to different computers.
When planning a distributed installation, be aware of the following factors:
• All servers on which the UC Analytics services are installed must have a static IP address defined.
• The port numbers that are specified for the various services are the user port numbers (1024-49151). Any
port number that you specify should not already be in use. If you have a firewall, ensure that the ports that
you specify have access.
• You can install additional collector roles (Data Engine and Query Engine). It is recommended that if you
install a Data Engine (Collector) on a server, you also install a Query Engine (Collector) on the same
server.
• To improve performance and distribute the data storage load, you can install multiple instances of the
Storage Engine service. Ensure that you specify a storage directory in which you have enough available
disk space; otherwise the installer will use the default installation location.

Unified Communications Analytics 8.5 Deployment Guide

23
Installing UC Analytics
For information about rules for distributed installations, see Rules when performing a distributed installation on
page 22.

To perform a production installation of UC Analytics

1 Copy the UC Analytics.exe file to the computer on which you want to install and double-click the file.
- OR -
Double-click the autorun.exe file and select the Install tab.
2 Beside the heading for the UC Analytics Installer, click Install.
3 Select Production Install.
4 Enter information about the environment from which you want to gather data such as the number of Active
Directory users, Exchange mailboxes, Skype for Business/Lync users, and/or Cisco users and the time that
you want to retain the collected data and click Next.
5 Select either Recommended Deployment or Advanced Deployment.
Recommended Deployment
If you selected Recommended Deployment, the installer displays the recommended deployment options
for one or more servers. It shows the recommended memory and storage for each configuration.
Table 11. Deployment options based on estimated RAM required.

Estimated RAM required Number of options displayed

Less than 64 GB RAM One option is displayed.
Greater than 64 GB RAM but less than 128 GB RAM Two options are displayed.
Greater than 128 GB RAM Three options are displayed

1 Select the option that you want.

The Configuration Deployment page shows all the service roles to be installed and shows a
placeholder server (Server1, Server2, and so on) with the appropriate roles selected.
2 Select a server and click Edit Properties.
3 Enter the actual server name for the server on which the service roles will be installed.
a If you want to install the service application binaries (program modules) on a drive other than
C or to a different directory, enter the path for the location in the Application Binaries
Directory Path field.
4 Repeat Step 2 and Step 3 for each server on which service roles will be installed.
Advanced Deployment
If you selected Advanced Deployment, the installer displays the Configuration Deployment page with all the
service roles to be installed and lists the current server with all roles selected.
1 To remove any roles from the current server, click Edit Properties and remove the roles that you do
not want installed.
2 To add additional servers and specify the roles that should be installed on each server, use the
following steps:
a Click Add Server.
b Specify the server name and select the check boxes for the server roles that are to be
installed.
c If you want to install the service application binaries (program modules) on a drive other than
C or to a different directory, enter the path for the location in the Application Binaries
Directory Path field.
d Repeat Step a and Step b for each server on which UC Analytics roles are to be installed.

Unified Communications Analytics 8.5 Deployment Guide

24
Installing UC Analytics
 For most installations, you can use the default values defined for each server role. However, you can
change the default values if necessary.
6 To change the default values for a server role, click Edit Properties.
7 Click Advanced, enter any changes to the properties for the selected server role and click OK.

Table 12. Data Engine service properties.

Query Port Number If the port is already used by another application, change the port
number. This port is used by the web site to access the Data Engine
service for query purposes.
Configuration Port Number If the port is already used by another application, change the port
number. This port is used by the web site to access the Data Engine
for configuration purposes.
Primary Data Collector When installing the Data Engine (Collector), you can specify that the
collector be used as the primary collector that is used to run any
background jobs such as Database Consistency. For information
about these jobs, see Data sources that run in background as needed
on page 40.
By default, the first installed Data Engine (Collector) is set to be the
Primary Data Collector.

Table 13. Query Engine service properties.

Physical Memory (MB) Ensure the check box is selected to calculate whether sufficient
Calculate automatically memory is available. If you clear the check box, the value you enter in
text box is assigned.
NOTE: Physical memory is automatically assigned during installation.
After you successfully install, if you display the properties dialog, the
currently installed physical memory is displayed in the text box.
Query Port Number If the port is already used by another application, change the port
number. This port is used by the Data Engine service to access the
Query Engine service.

Table 14. Storage Engine service properties.

Physical Memory (MB) Ensure the check box is selected to calculate whether sufficient
Calculate automatically memory is available. If you clear the check box, the value you enter in
text box is assigned.
NOTE: Physical memory is automatically assigned during installation.
After you successfully install, if you display the properties dialog, the
currently installed physical memory is displayed in the text box.
Query Port Number If the port is already used by another application, change the port
number. This port is used by the Query Engine service to access the
Storage Engine service.

8 In the Storage Directory Path field, specify the directory path in which all the collected data is stored and
click Next.
The UC Analytics installer verifies the hardware prerequisite for required disk space against actual disk
space and physical memory (RAM) on the selected servers for the roles you have specified and provides
recommendations for your hardware configuration.
9 Enter the credentials that will be used to run the Data Engine service and click Next.
The account must be a domain account (not a local computer account) and must have local Admin rights to
the computer on which the Data Engine service is being installed.
10 Verify that the software prerequisites are met.

Unified Communications Analytics 8.5 Deployment Guide

25
Installing UC Analytics
 11 Specify the users who will be product administrators and have access the Admin Settings and click Next.
By default, the account used to install UC Analytics is added to the accounts that can access the Admin
Settings. By rerunning the installer and selecting Change Product Administrators, you can add or
remove product administrators.
12 Accept the license agreement and install the product.
13 To access Admin Settings, open the UC Analytics web site:
http://<ServerName>/Analytics

14 To begin product configuration, click the gear icon on the home page side bar. For more information,
see Configuring UC Analytics on page 28.

Installing additional Storage Engine services

after installation
At some later date, you might decide you need to install additional Storage Engine services to distribute your
stored data. For information about adding more Storage Engines to an existing installation, see Deploying
additional Storage Engines on page 112.

TIP: When you view an existing deployment in the Configure Deployment page, you can identify the
Data Engine (Collector) that is used as the Primary Data Collector since it is identified up arrow icon
instead of a check mark.

Installing additional collector roles

Once you have determined how much data the different data sources collect, you might want to install additional
collector roles on different and assign certain data sources to use those collectors. It is recommended that if you
install a Data Engine (Collector) on a server, you should install a Query Engine (Collector) role on the same server.
For information about adding collector roles to an existing installation see Deploying additional collectors on page
113.

Activating the UC Analytics license

After you download a trial version or purchase UC Analytics, you will receive a license file (.dlv) through email.
After you install UC Analytics but before you can use UC Analytics, you must activate the license.

To activate a license
1 Copy the license file (xxx-xxxx.dlv) to a computer on which the UC Analytics Data Engine service is
installed.
2 Start Quest UC Analytics | Quest UC Analytics from the Start menu or run the DeploymentManager.exe file
from the product installation directory.
3 Click the Manage Licenses button.
4 Click Add License and browse to the location where license file (xxx-xxxx.dlv) is copied and install it.

Unified Communications Analytics 8.5 Deployment Guide

26
Installing UC Analytics
Setting up the web site for HTTPS
Generally it is recommended that you set security for your UC Analytics web site. The steps for configuring Secure
Sockets Layer (SSL) or Transport Layer Security (TLS) for a site generally include the following:
1 Get an appropriate certificate.
2 Create an HTTPS binding on a site.
3 Optionally, configure TLS/SSL options by making TLS/SSL a requirement.
4 Test by making a request to the site.
First you must obtain a web server certificate. For information about how to install an Internet Server Certificate
(IIS 7.0) see the following article:
http://technet.microsoft.com/en-us/library/cc731977(v=ws.10)
After the certificate is obtained, you must install it. Now you can configure the https binding and the TLS/SSL
options. Use the procedure that follows.

To add the https binding and configure the TLS/SSL options

1 Open IIS Manager.
2 In the Connections pane, expand the Sites node in the tree and select the Default Web Site.
3 In the Actions pane, click Bindings.
4 In the Site Bindings dialog box, click Add.
5 In the Add Site Binding dialog box, add the binding information including the certificate and click OK.
6 In Features View at the UC Analytics application level, double-click TLS/SSL Settings.
7 On the TSL/SSL Settings page, select Require TLS/SSL.
8 In the Client certificates area, select Ignore.
9 In the Actions pane, click Apply.
10 To open the web site, enter the following address in the browser:
https://<ServerName>/Analytics/

Unified Communications Analytics 8.5 Deployment Guide

27
Installing UC Analytics
 3
Configuring UC Analytics
• About administration settings
• How do I set a user to be a product administrator?
• Configuration process overview
• Modifying the initial target environment
• Adding multiple Active Directory forests
• Configuring UC Analytics for resource forests
• Adding a target environment for native Office 365
• Setting the time period for retaining data
• Setting the start date for data collection
• Adding and configuring data sources
• How often do collections update the data?
• Viewing the collection job status
• Forcing a data source collection to run now
• Renaming a data source
• Identifying your internal domains
• Classifying domains for message traffic
• Granting full access to Admin Settings
• Granting users access to data
• Accessing the UC Analytics web site

About administration settings

If you are a product administrator, you can configure UC Analytics at the following location:
http://<ServerName>/Analytics/

Click the gear icon on the home page side bar to access Admin Settings.
Before you begin to use UC Analytics to gather and analyze information, you must specify settings that determine
what data is collected (data sources) and when it is collected. Depending on the data sources that you configure,
UC Analytics can collect different types of data.
You configure classifications to identify the domains that are internal to your organization, to configure call
classifications for Skype for Business/Lync and Cisco, and to set thresholds for quality metrics for the different
platforms.
In the Admin Settings, you also configure security to control which users can see data in which insights. For
example, you can specify security settings which determine whether specific users can see detailed or aggregate
data for the Exchange messages and Skype for Business/Lync data.

Unified Communications Analytics 8.5 Deployment Guide

28
Configuring UC Analytics
How do I set a user to be a product
administrator?
When you install UC Analytics, you can add users as product administrators during installation. A product
administrator has unrestricted access to all the configuration settings under the Admin Settings for all tenants
(target environments).
After installation, to add additional administrators you can use the UC Analytics Deployment Manager from the
Start menu.

To access the Deployment Manager

1 Click Start and select Programs | Quest UC Analytics | UC Analytics.
2 Select the Change Product Administrators option.

About multi-tenant environments

For implementations in which you have multiple tenants, you can add separate environments for each tenant. In
this case, you could add tenant administration rights for a specific environment to an account. The account would
be the tenant administrator only for the tenant environment.
For information about configuring an account with access to the admin settings for a specific environment (tenant),
see Adding a tenant administrator on page 45.

Configuration process overview

If your user account is set as a product administrator or with access to Tenant Configuration (tenant administrator),
you can configure UC Analytics using the Admin Settings. The following steps provide a sample workflow for an
initial configuration and identify the tile (in parentheses) in which you enter the configuration.

1 Click the gear icon on the home page side bar to access Admin Settings.
2 Review the target environment used to create the initial connection. (Target Environments)
3 Add any additional target environments such as another Active Directory forest or a native Office 365
deployment. (Target Environments)
4 Add and configure the data sources used to create the data collections that gather data. (Data Collection).
For information about configuring each type of data source, see the following sections:
▪ Adding data sources for Active Directory or Azure Active Directory on page 52
▪ Adding data sources, chargeback costs, and thresholds for Exchange and Exchange Online on
page 57
▪ Adding data sources, chargeback costs, and thresholds for Skype for Business/Lync on page 89
▪ Adding data sources, chargeback, and thresholds for Cisco on page 100
5 Set a data aging time period for the data you collect (Data Collection).
6 Set the initial data collection start date (Data Collection).
7 Identify the domains that are internal to your environment (Classifications | Domain Classifications).
This information is used in insights to identify internal and external message traffic and Skype for
Business/Lync activities.
8 Specify classifications that map to specific domains (Classifications | Domain Classifications).

Unified Communications Analytics 8.5 Deployment Guide

29
Configuring UC Analytics
 The classifications are used to group the Exchange messaging, Skype for Business/Lync session and
conference data, and Cisco session and conference in the insights.
9 Set security to set the levels of access to the Exchange, Skype for Business/Lync, and Cisco data that
each user has when viewing insights (Security).
Other configuration tasks can include:
• Specifying words that should be omitted when filtering for subject keywords (Queries).
• Entering the call classifications for the different Skype for Business/Lync or Cisco call types (Classifications
| Call Classifications).
• Entering the cost values to be used for chargeback insights (Chargeback).
• Configuring the global settings that are used by user-created subscriptions for insights (Subscriptions).
For more information about subscriptions, see the section titled “Automatically creating and sending
insights” in the UC Analytics User Guide.

Modifying the initial target environment

When you install UC Analytics, the installer creates an initial target environment. By default, the target environment
is the Active Directory forest (or workgroup) in which UC Analytics is installed. The target environment is used to
collect data and to provide users with access to the UC Analytics web site.
Check the initial target environment to verify that the default credentials being used for authentication have the
required permissions. For more information, see About the authentication credential on page 31.
For Office 365, the initial target environment is set by default for the Microsoft global network of data centers. In
addition to the global cloud, Microsoft cloud services are available in separate national clouds. National clouds are
physically and logically isolated networks, located within the geographic borders of certain countries and operated
locally.
Current national clouds include:
• Azure and Office 365 operated by 21Vianet in China
• Microsoft Cloud Germany
• Microsoft Cloud for US Government
If you are accessing Office 365 through a Microsoft national cloud, you can set the connections used for Office 365
to use the national URLs.
To provide access for users or to collect data from outside the initial target environment, you can add a new target
environment. You can add target environments to connect with other Active Directory forests or with a native Office
365 deployment:
• If you have a hybrid Office 365 environment with users in both Office 365 and in Active Directory, you would
add another Active Directory forest / Office 365 (hybrid) environment.
• If you have a native Office 365 environment, you would add an Office 365 (native) target environment and
allow your Office 365 users to be authenticated.

To review or modify the initial target environment

1 Click the gear icon on the home page side bar.

2 Click Target Environments.
By default, an environment is configured for the Active Directory forest in which you installed UC Analytics.
3 Click the tile for the forest.
4 Review the information. The Allow users from this target environment to log in to UC Analytics check
box is selected. This indicates that the environment is used for authenticating users.

Unified Communications Analytics 8.5 Deployment Guide

30
Configuring UC Analytics
 5 Specify an Authentication Credential, if necessary.
If you are collecting Office 365 data from a Microsoft national cloud
6 Select Use specific connection URLs under Office 365 Hybrid Connections.
7 Click Set URLs.
8 On the Set URLs dialog, enter the URL that is to be used for the remote PowerShell connection and the
URL to be used for the Exchange Web Services (EWS) connection.
For example, to connect to Office 365 in China, you could enter:
▪ https://partner.outlook.cn/PowerShell
▪ https://partner.outlook.cn/EWS/Exchange.asmx
9 Click Set. and click Save.

About the authentication credential

If you have a single forest, you typically do not need to specify an Authentication Credential in the default target
environment. By default, the credentials specified for the Data Engine service are used to verify user permissions.
However, in secure environments, you might need to restrict rights for the UC Analytics service account. You could
install UC Analytics using a local computer account or using a domain account with restricted rights.
In this case, you specify an Authentication Credential in the default environment to allow users to access UC
Analytics:
• The credential must have read rights to the Active Directory forest specified in the target environment.
• The credential must also have sufficient rights to browse users and groups and to resolve group
memberships for all users and groups from this environment that are specified in the Security settings. For
information about the Security settings, see Granting users access to data on page 45.
If you do not provide an authentication account or if the account has insufficient rights, the security settings to
access data are not applied when user attempts to log in to UC Analytics. As a result, the user might be unable to
log into UC Analytics or unable to access certain insights.

Adding multiple Active Directory

forests
When you install UC Analytics, an initial target environment is created for the Active Directory forest in which you
installed. You can add target environments for other Active Directory forests/Office 365 hybrid environments.
If you add target environments for additional Active Directory forests, there must be at two-way or a one-way trust
between the forest from which you collect data and the forest in which UC Analytics is installed.
For detailed instructions about configuring target environments for a multi-forest environment with a one-way trust,
see Setting up a multi-forest environment with a one-way trust on page 129.

To add an target environment for an additional Active Directory forest or Office 365 hybrid
environment

1 Click the gear icon on the home page side bar.

2 Click Target Environments.
3 Click + beside Target Environments.
4 Select Active Directory Forest / Office 365 (hybrid).

Unified Communications Analytics 8.5 Deployment Guide

31
Configuring UC Analytics
 5 Under Name, click Active Directory Forest / Office 365 (hybrid).
6 Enter a name to identify the forest and click Apply.
7 Under Forest Name, click the <None specified> field.
8 Enter a domain name associated with the forest
9 If necessary, enter the credential that is used to access Active Directory and resolve the forest.
10 Click Resolve Forest Name.
The name of the forest in which the domain resides is displayed.
11 Click Apply.
12 If this environment is to be used for authenticating users, select the check box beside Allow users from
this target environment to log in to UC Analytics.
13 Specify the credential if the credential is to be used for authentication.
14 Click Add.
If you are collecting Office 365 data from a Microsoft national cloud
15 Select Use specific connection URLs under Office 365 Hybrid Connections.
16 Click Set URLs.
17 On the Set URLs dialog, enter the URL that is to be used for the remote PowerShell connection and the
URL to be used for the Exchange Web Services (EWS) connection.
For example, to connect to Office 365 in China, you could enter:
▪ https://partner.outlook.cn/PowerShell
▪ https://partner.outlook.cn/EWS/Exchange.asmx
18 Click Set. and click Add.

Configuring UC Analytics for resource

forests
If you have resource forests, typically your active (enabled) user accounts are in one forest and the Exchange /
Skype for Business (Lync) resources (such as mailboxes) are in a different forest. In other cases, there might be a
mix of user accounts and resources in a single forest.
You must configure UC Analytics to collect the Active Directory information from the account and resource forests
and to collect the Exchange and Skype for Business (Lync) information from the resource forests.

Adding target environments

For each forest that contains Active Directory accounts and/or Exchange / Skype for Business (Lync) resources,
you must:
• add a target environment for each forest that hosts Exchange (pure resource forest).
• add a target environment for each forest that hosts Skype for Business or Lync (pure resource forest).
• add a target environment for each forest that hosts the Active Directory accounts that access Exchange
and/or Skype for Business (pure account forest).
• add a target environment for each forest that hosts the Exchange resources, Skype for Business
resources, and any Active Directory accounts used to access Exchange and Skype for Business (blended
forest).

Unified Communications Analytics 8.5 Deployment Guide

32
Configuring UC Analytics
Configuring data sources
For each forest target environment, you must add a Domain Controller data source.
For each forest target environment that hosts Exchange resources (both pure resource forests and blended
forests), you must add the Exchange data sources (such as the Exchange Configuration and IIS Log Files data
sources).
For each forest target environment that hosts Skype for Business / Lync resources (both pure resource forests and
blended forests), you must add Skype for Business / Lync data sources (such as the Skype for Business / Lync
Configuration and the Skype for Business / Lync CDR Database data sources).

Resource forest configuration process

In the Admin Settings, the configuration process is as follows:
1 In Target Environments, add a target environment for each forest that:
▪ hosts the Active Directory users that are used to access Exchange or Skype for Business (Lync)
▪ hosts Exchange resources.
▪ hosts Skype for Business (Lync) resources.
2 In Data Collection, add a Domain Controller data source in each of the target environments.
The data source collects the Active Directory objects of each forest. The Domain Controller data source is
also needed in a resource forest to collect the security groups and distribution groups.
For Exchange resource forest configuration
3 In Data Collection, add an Exchange Configuration data source in each target environment of a forest that
hosts Exchange resources. Configure as usual with the following extra steps:
a In each Exchange Configuration data source, select the Search additional forests for master
accounts of linked mailboxes check box.
The additional Account Forest LDAP Connection Parameters are displayed.
b Specify whether the domain controller for the account forest should be automatically discovered or
enter a specific domain controller.
c Enter the additional LDAP connection parameters to the account forest that contains the master
accounts for the Exchange-linked mailboxes.
The additional LDAP credentials are needed to resolve the master account SID of linked mailboxes
to the distinguished name of the master account in the account forest.
For Skype for Business (Lync) resource forest configuration
4 In Data Collection, add a Skype for Business / Lync Configuration data source in each target environment
of a forest that hosts the Skype for Business (Lync) resources. Configure as usual with the following extra
steps:
a In each Skype for Business / Lync Configuration data source, select the Search additional forests
for user accounts for the linked Skype for Business / Lync services check box.
The additional Account Forest LDAP Connection Parameters are displayed.
b Specify whether the domain controller for the account forest should be automatically discovered or
enter a specific domain controller.
c Enter the additional LDAP connection parameters to the account forest that contains the primary
Skype for Business (Lync) user accounts.
The additional LDAP credentials are needed to resolve the Skype for Business (Lync) originator SID
of the resource (disabled) accounts to the distinguished name of the primary account in the account
forest.

Unified Communications Analytics 8.5 Deployment Guide

33
Configuring UC Analytics
Resource forest: collecting from active and disabled user
accounts
In a resource forest configuration, both the active (master or primary) user account and the disabled (stand-in)
user account can have values specified for the user properties. UC Analytics collects these properties as follows:
• If a property is multi-valued, such as email addresses, UC Analytics collects the values from both the
master and stand-in accounts.
• If the property is single-valued, such as department, UC Analytics collects the values from both the master
and stand-in accounts. When the value is present in both accounts, the stand-in account value is used with
the following exceptions which are always collected from the master account:
▪ Name
▪ First Name
▪ Initials
▪ Last Name
▪ SAM Account Name
▪ OU
▪ Object GUID
▪ Object Type

NOTE: If a master mailbox (Exchange) or primary user (Skype for Business) is associated with more
than one stand-in (linked mailbox or disabled account) in more than one resource forest, single-
valued properties can be populated from any one of the stand-ins.

Adding a target environment for native

Office 365
If you have a native Office 365 environment, without on-premise Exchange or Active Directory, you can add a
Office 365 target environment to connect directly to your native Office 365 environment.

To add a target environment for native Office 365

1 Click the gear icon on the home page side bar.

2 Click Target Environments and click + beside Target Environments.
3 Select Office 365 (native).
4 Under Name, click Office 365 (native).
5 Enter a descriptive name for the environment and click Apply.
6 To use this environment for authenticating users, select the check box beside Allow users from this
target environment to log in to UC Analytics.
This setting only controls whether the users from this target environment can log in to UC Analytics. You
control the types of data that users can view in the insights through the Admin Settings | Security section.
For information, see Granting users access to data on page 45.
7 Click Set credential and enter the Office 365 credential to be used to resolve user security settings for
users that log in with Office 365 credentials.
8 Click Set.

Unified Communications Analytics 8.5 Deployment Guide

34
Configuring UC Analytics
 If you are collecting Office 365 data from a Microsoft national cloud
9 Select Use specific connection URLs under Office 365 Native Connections.
10 Click Set URLs.
11 On the Set URLs dialog, enter the URL that is to be used for the remote PowerShell connection and the
URL to be used for the Exchange Web Services (EWS) connection.
For example, to connect to Office 365 in China, you could enter:
▪ https://partner.outlook.cn/PowerShell
▪ https://partner.outlook.cn/EWS/Exchange.asmx
12 Click Set.
13 Click Add.

Setting the time period for retaining

data
On the Data Collection page, you can set the amount of time that data is retained by the UC Analytics Storage
Engine. This feature allows you to automatically age data from the Storage Engine database to manage the
amount of storage required.
The data aging job runs automatically at midnight (local time).
If you have the data retention period set for a longer period such as 365 days and you reduce the number of days
for retention, you cannot later recollect the older data that was not retained. If you increase the number of days,
the change only affects new message or session activity.

To set the data retention time period

1 Click Data Collection.
2 Enter the number of days that you want data to be retained in the Data Retention Length (days) field.

Setting the start date for data collection

On the Data Collection page, you set the date that you want data collection to start. By default, the initial data
collection is set to start 30 days back for on-premise data sources and one day for Office 365 (Exchange Online)
data sources.
For on-premise data sources, if you have stored data that goes more than 30 days back, you might want to change
the start date for data collection. For example, typically Exchange tracking logs are retained for 30 days. If you
normally archive your Exchange tracking logs and have logs that go back beyond 30 days, you could set the data
collection start date to reflect the actual dates for the data that you have stored.

To set the data collection start date

1 Click Data Collection.
2 Enter the start date for which data is to be collected in the Data Collection Start Date field.
You can only change the start date if you have not added any data sources yet.

Unified Communications Analytics 8.5 Deployment Guide

35
Configuring UC Analytics
Adding and configuring data sources
You can configure the data sources to create the data collections that collect information from different
environments. The workflow to add data sources and set up data collection is similar for each target environment.

Data source name Types of information collected

Active Directory data sources for Active Directory Forest/Office 365 Hybrid target environment
Domain Controller User, group, and contact data from Active Directory. See Creating an
Domain Controller data source on page 54.
Office 365 User User subscription information including licenses and subscribed services
Subscription Configuration such as Exchange Online, Skype for Business Online, SharePoint Online,
using remote PowerShell.
See To set up an Office 365 user subscription configuration collection on
page 55
Azure Active Directory data sources for native Office 365 target environment
Office 365 User User subscription information including licenses and subscribed services
Subscription Configuration such as Exchange Online, Skype for Business Online, SharePoint Online,
using remote PowerShell.
See To set up an Office 365 user subscription configuration collection on
page 55
Exchange data sources for Active Directory Forest/Office 365 Hybrid target environment
Exchange Configuration Exchange configuration from the Exchange server including organization,
server, DAG, mailbox, database status, database copy, mobile device
configuration, personal archive and mailbox statistics. See Creating a data
source for Exchange configuration on page 64.
Exchange Tracking Logs Exchange message traffic and DLP rule matches from your Exchange
message tracking logs. See Creating a data source for Exchange tracking
logs on page 68.
Exchange Mailbox Exchange message data through Exchange Web Services (EWS) from your
Contents target mailboxes. See Creating a data source for Exchange mailbox
contents on page 69.
Exchange IIS Logs Mobile device events and email statistics from the ActiveSync IIS log files on
Exchange Client Access Services (CAS). Also can collect Outlook on the
Web (OWA) logon details. See Creating a data source for Exchange IIS
Logs on page 72.
Exchange Mailbox Content Statistics including size and number of items for mailbox folders such as
Summary Inbox, Deleted Items, and Junk E-Mail. See Creating a data source for
Exchange mailbox content summary on page 74.
Exchange Public Folders Statistics for legacy public folders (Exchange 2010) and for new public
folders (Exchange 2013 and Exchange 2016). See Creating a data source
for Exchange public folders on page 76.
Exchange Online Hybrid Detailed information for Exchange Online users and distribution groups in a
User Configuration hybrid environment. See Creating a data source for Exchange Online hybrid
user configuration on page 78.
Exchange Online Hybrid Exchange Online mailbox statistics, permissions, and mobile device data
Mailbox Configuration from a hybrid (Office 365 and on-premise Exchange) environment. See
Creating a data source for Exchange Online hybrid mailbox configuration on
page 79.
Exchange Online Mailbox Information about email traffic from Exchange Online user mailboxes using
Contents Exchange Web Services (EWS). You can collect from some or all mailboxes.
See Creating a data source for Exchange Online mailbox contents data
source on page 83.

Unified Communications Analytics 8.5 Deployment Guide

36
Configuring UC Analytics
Data source name Types of information collected
Exchange Online Mailbox Statistics including size and number of items for mailbox folders for
Content Summary Exchange Online mailbox users. See Creating a data source for Exchange
Online mailbox content summary data source on page 84.
Exchange Online data sources for native Office 365 target environment
Exchange Online Native Exchange Online user and group data from a native Office 365 environment
User Configuration using PowerShell. See Creating a data source for Exchange Online native
user configuration on page 81.
Exchange Online Native Exchange Online mailbox configuration including statistics, permissions and
Mailbox Configuration mobile devices from native Office 365 using remote PowerShell.
See Creating a data source for the Exchange Online native mailbox
configuration data source on page 82.
Exchange Online Mailbox Information about email traffic from Exchange Online user mailboxes using
Contents Exchange Web Services (EWS). You can collect from some or all mailboxes.
See Permissions needed for Exchange Online mailbox contents data on
page 62.
Exchange Online Mailbox Statistics including size and number of items for mailbox folders for
Content Summary Exchange Online mailbox users. See Creating a data source for Exchange
Online mailbox content summary data source on page 84.
Skype for Business/Lync data sources for on-premise Active Directory forest target environment
Skype for Business/Lync Server, pool, and user policy configuration data directly from the Skype for
Configuration Business/Lync server. See Creating a data source for Skype for
Business/Lync configuration on page 90.
Skype for Business/Lync Skype for Business/Lync peer-to-peer session and conference data from the
CDR Database CDR database. See Creating a data source for Skype for Business/Lync
CDR on page 92.
Skype for Business/Lync Skype for Business/Lync Quality of Experience (QoE) data from the QoE
QoE Database database. Creating a data source for Skype for Business/Lync QoE on page
93.
Cisco data sources for on-premise Active Directory forest target environment
Cisco Configuration Cisco server and end-user data the Cisco Unified Communications Manager
server and synchronized user data from Active Directory. See Creating a
data source for Cisco configuration on page 101.
Cisco CDR Logs Cisco peer-to-peer call, ad hoc conference call, and meet-me conference
call information from Cisco CDR log files. See Creating a data source for
Cisco CDR logs on page 102.

To set up data collection for your environments

1 Click the gear icon on the home page side bar.

2 Click Data Collection.

3 Click + beside the name of the target environment.
4 Select the data sources for Active Directory (Domain Controller), Exchange, Skype for Business/Lync,
Cisco, and Office 365 from which you want to collect data
Tiles for each data source are displayed.
5 Click the data source tile to enter the configuration information for the data collection.
6 For specific instructions about how to create data sources for each supported platform, see the following
sections:
▪ Adding data sources for Active Directory or Azure Active Directory on page 52

Unified Communications Analytics 8.5 Deployment Guide

37
Configuring UC Analytics
 ▪ Adding data sources, chargeback costs, and thresholds for Exchange and Exchange Online on
page 57
▪ Adding data sources, chargeback costs, and thresholds for Skype for Business/Lync on page 89
▪ Adding data sources, chargeback, and thresholds for Cisco on page 100

Adding more than one instance of the same

data source
You must add data sources for each target environment that you have created. So if you have two Active Directory
forests added as target environments, you would add the same data sources for each target environment.
For performance reasons, you can add multiple data sources of the same type to distribute the collection load or
for different platform versions. For example, you would add an Exchange configuration data source for your
Exchange 2010 servers and an Exchange configuration data source for your Exchange 2013/2016 servers.
You can use the rename option to rename each data source so that it reflects the information that is being
collected. For information about renaming data sources, see Renaming a data source on page 43.

Specifying explicit domain controllers for LDAP

connections
For data sources that require an LDAP connection, auto-discovery is used by default to determine the domain
controller that is used. However, for a large environment, you might want to explicitly specify a pool of domain
controllers to be used rather than using auto-discovery.
For example, in a large environment you might configure six or more Exchange Configuration data sources,
several Tracking Logs data sources, and several IIS Logs data sources. If all the data sources use auto-discovery
for the LDAP connection, the data sources would tend to use the same domain controller. To avoid this situation,
you can specify a pool of domain controllers to be used for certain collections to spread the gathering load.
If you decide to specify a pool of domain controllers, UC Analytics will resolve the LDAP connection to the first
available domain controller. If several different data collections use the same pool with the same sequence of
domain controllers, the data source collections may all resolve to the same domain controller. For this reason, you
should vary the first domain controller that is specified when you specify a pool of domain controllers for a
collection.
The following data sources require LDAP connections:
• Domain Controller
• Exchange Configuration
• Exchange Mailbox Contents
• Exchange IIS Logs
• Exchange Tracking Logs
• Exchange Mailbox Content Summary
• Exchange Online Hybrid User Configuration
• Exchange Online Hybrid Mailbox Configuration
• Skype for Business/Lync Configuration
• Cisco Configuration

Unified Communications Analytics 8.5 Deployment Guide

38
Configuring UC Analytics
To explicitly specify domain controllers for LDAP connections
1 On the data source configuration page, select Show advance settings in the LDAP Connection
Parameters section.
2 Under Global Catalog Domain Controller, select Use specific domain controller and click Add domain
controller.
3 Enter the host name or FQDN for the domain controller and click Add.
4 Repeat step 3. for each domain controller you want to add.
- OR -
5 Enter the FQDN or host names for all the domain controllers you want, each entry separated by a semi-
colon (;), and click Add.

Recommendations for collecting from Office

365
Many of the data sources that collect from Office 365, including Exchange Online (hybrid or native), use remote
PowerShell to collect the data from Office 365. You must specify the account is used to connect to Exchange
Online when you configure the data source.
It is recommended that you specify a different account for the PowerShell credentials that are used for each
Exchange Online or Office 365 data source that you configure.

When would I use the Delete Data option?

On the Data Collections page, there is a Delete Data button. Typically you only use this option if you want to delete
all the data you have collected. To do this, you must first delete all the data sources that you have configured. By
deleting all the data sources and then deleting all the collected data, you can essentially start over again.
If you only want to remove old data, adjust the time period for data retention.

How often do collections update the

data?
By default, each data collection has a default schedule.When you configure a data collection, you have the option
of changing the schedule for that collection.
After a data collection is created and is running on a regular basis, you can change the collection. For example,
you could select additional types of data to be collected. For some types of data, the data is collected only once a
day so the new data will not be available in insights until the following day.

Updated each time collection is run

Some of the data collections update each time that the collection job is run. For these data collections, only the
data that changed from the previous job run is gathered. The data collections that update the data that changed
since the last run are:
• Exchange Tracking Logs (message traffic, DLP matches) using PowerShell and LDAP.
• Exchange Mailbox Contents (message information) using LDAP and EWS.

Unified Communications Analytics 8.5 Deployment Guide

39
Configuring UC Analytics
 • Exchange ActiveSync IIS Logs (mobile device event and email statistics, OWA logons) using PowerShell
and LDAP.
• Exchange Online Mailbox Contents (message information) using EWS.
• Skype for Business/Lync CDR Database (peer-to-peer session and conference information)
• Skype for Business/Lync QoE Database (Quality of Experience data)
• Cisco CDR Logs (peer-to-peer calls, ad hoc conference calls, and meet-me conference calls)

Once a day “snapshot” collections

Some data collections take a once-a-day “snapshot” of the data even if they are scheduled to run more than once
a day. Data collections that gather data only once a day are:
• Active Directory Domain Controllers (user information) through LDAP.
• Exchange Configuration (Exchange server, database, mailbox, mobile device configuration, and statistics)
using LDAP and PowerShell.
• Exchange Mailbox Content Summary (mailbox folder statistics for Exchange user mailboxes) using LDAP
and EWS.
• Exchange Public Folders (statistics for legacy and new public folders) using remote PowerShell.
• Exchange Online Hybrid Mailbox Configuration (mailbox information) using LDAP and PowerShell.
• Exchange Online Hybrid User Configuration (users and distribution groups) in hybrid environments using
LDAP and remote PowerShell.
• Exchange Online Native Mailbox Configuration (mailbox information) using remote PowerShell.
• Exchange Online Native User Configuration (user information) using remote PowerShell.
• Office 365 User Subscription Configuration (subscription configuration) using remote PowerShell.
• Exchange Online Mailbox Content Summary (mailbox folder statistics) for Exchange Online user mailboxes
using EWS.
• Skype for Business/Lync Configuration (server, pool, and user policy configuration) using LDAP and
PowerShell.
• Cisco Configuration (LDAP for Active Directory and Cisco Unified Communications Manager)

Data sources that run in background as needed

Additionally, there are data collections that run in the background and update data only as needed:
• Database Consistency (used to ensure messages received before and after UTC midnight are inserted in
the database only once).
• Exchange Calculation (recipient response times, message delivery times)
• Cisco Calculation (duration times for ad hoc conferences)
• Data Query Availability (used to make the data available for queries. Data collected between runs of the
Data Query Availability job are not available until the job runs)
For more information, see How often do the data collections actually gather data and when do they run? on page
142.

Unified Communications Analytics 8.5 Deployment Guide

40
Configuring UC Analytics
Viewing the collection job status
After the data collection start date, specified on the Data Collection page, the UC Analytics data collections begin
to gather information. To view the progress of the collection jobs and to see if there are any errors during the
collections, click View Data Collection Status at the top right of the Data Collections page.

Figure 2. Viewing data source collection job status.

By default, UC Analytics only shows the status from the last job run for each data source (Most recent / running). If
a collection job shows errors or warnings, you can view the details in the Details pane at the bottom. Use the
Show errors only check box and the Show warnings only check box to select whether you want to only errors,
only warnings, or both errors and warnings.
Using the filter options, you can filter for a specific data source or job status to determine if a data collection has
been running correctly. You can also narrow the returned results by specifying a custom date range.

Copying the job details information

If you want to copy the contents of the job details, double-click on the row that contains the details you want. The
Details Copy option displays and you can copy the details and paste the text into a separate document.

Filtering job status results by state or type

You can filter the job status results to view only jobs that succeeded, jobs that failed, jobs that are currently
running, or jobs that completed with warnings. You can also filter for a specific data source (job type).

• To filter by job status, click in status field and select a status of running, succeeded, failed, or warning.

• To fitter by the data collection, click in the job type field and select the data source for which you want to
see all data collection job status information.

Unified Communications Analytics 8.5 Deployment Guide

41
Configuring UC Analytics
To search for a specific data source, enter part or all of the data source name in the search field.
For information about how often data collections gather data, see How often do collections update the data? on
page 39.

Filtering job status results by date range

The UC Analytics keeps 30 days of job status records by default but the job status page can only display 15,000
records. If there are more than 15,000 records in the database, you can filter the results by date range.
By default, the job status page shows the most recent result for each data source collection.

To filter by date range

1 Click the beside Most recent only in the date range field
2 Select the time period that you want:

Today
Yesterday
Last 7 days
Last 14 days
Custom

3 If you select Custom, specify the start date and the end date for the time period:
a Enter or select the start date in the left field.
b Enter or select the end date in the right field.
The job status page displays only the job status records that fall within the specified date range.

Forcing a data source collection to run

now
After you have created and scheduled your data source collections, you may want to have a collection run
immediately. For example, you might have added new targets for a data source collection and want get updated
data before the next scheduled collection.

To run a data source collection immediately

1 On the Admin Settings | Data Collections page, hover your cursor over the data source that you want to
run.
Several icons display on the options menu on the right side of the data source tile.

Unified Communications Analytics 8.5 Deployment Guide

42
Configuring UC Analytics
 Figure 3. Displaying the data source options menu.

Run now

2 Select the Run now icon.

A new data collection job is started for the data source.
If you use the Run now option for a data source that only takes a once-a-day “snapshot” of the data, no new data
is collected unless you have added a new target. For information about how often data collections gather new
data, see How often do collections update the data? on page 39.

Renaming a data source

You can create more than one data collection for the same data source. By adding multiple data source
collections, you can distribute the load of collecting resource-intensive data.
For example, you can collect mailbox permissions and Active Directory extended permissions through the
Exchange configuration data source. Collecting the permissions data can be very time-consuming. You can add
and configure multiple Exchange configuration data sources to collect different subsets of the target mailboxes to
collect this information.
Once you have added more than one Exchange configuration data source, you can rename each data source to
more clearly identify what data is collected from each data source.

To rename a data source

1 On the Data Collection page, hover over the right corner of the data source tile and click .
2 Select Rename.
3 Enter a descriptive name for the data source and click Save.

Identifying your internal domains

Using the Classifications page, you identify the domains which are internal to your organization. You identify your
internal domains to allow insights to show internal and external email traffic, Skype for Business/Lync sessions,
and other related information correctly.

To identify internal domains

1 Click the gear icon on the home page side bar.

2 Click Classifications and click Domain Classifications.
3 Click Add domain for the Internal Domains.
4 Enter any domains that are considered internal to your business and click Apply.
You can modify or add domains at any time. After you have made changes, the existing data in the insights is
reclassified (internal and external) immediately.

Unified Communications Analytics 8.5 Deployment Guide

43
Configuring UC Analytics
Guidelines when specifying domains
Some messages may not come directly from a domain so remember to add subdomains or to specify * in the
domain name.
For example, you could add both DomainA.com and *.DomainA.com to the Domain Classifications list to include
DomainA.com and all of its sub-domains. If you entered *DomainA.com, you would get the domain and the
subdomains but you would also get “AnotherDomainA.com” as well.
Entries in the Custom Domain Classifications list are not case-sensitive so it doesn’t matter if you enter the domain
names as capital letters or lower case letters.
You can also add your own custom classifications. Since there will not be a default insight for your new
classification, you can create a new insight and use the filters to select the new classification.

Classifying domains for message

traffic
You also can assign classifications to domains that determine how messages to and from the domains are
classified in the insights. For example, using the Classification page you could specify that gmail.com should be
classified as a “Personal” domain. For email where the sender or the receiver is in the specified domain, the
messages are tagged with the associated classification.
You can assign domains to the following categories:
• Competitor
• Partner
• Customer
• Personal
• Social Network

NOTE: Domains which are not added to the internal domains list are treated as external, regardless of their
classification.

To set classifications for messages

1 Click the gear icon on the home page side bar.

2 Click Classifications and click Domain Classifications.
3 Click Add domain classifications.
4 Enter the domain and the classification that is used for all messages sent from and to the domain, and click
Add.
5 Repeat steps 3 and 4 for each domain you want to classify in your insights.

Unified Communications Analytics 8.5 Deployment Guide

44
Configuring UC Analytics
Granting full access to Admin Settings
In the Security settings, under the Access to Tenant Configuration heading, you can add a user to grant the
account full access to the Admin Settings that are used to configure UC Analytics. This user is a product
administrator. However, this option only grants access to the Admin Settings used to configure UC Analytics and
does not grant access to the collected data.
For product administrator to have access to the collected data in insights, both aggregate and unrestricted, you
must also grant the account access for each type of data. For information see Granting users access to data on
page 45.

To add user as a product administrator

1 Click the gear icon on the home page side bar.

2 Click Security.
3 Under the Access to Tenant Configuration section, click Add Users.
4 Leave the Grant access to all users in all target environments check box empty.
5 Select the target environment.
6 Enter a specific user (email address or SAM account name) to be granted full access to the Admin
Settings.
7 Click Add. and click Save.

Adding a tenant administrator

If you have a multiple tenant implementation, you might want to create a tenant administrator who would only have
access to the configuration settings for a specific environment (tenant).

To set up an account as a tenant administrator

1 Click the gear icon on the home page side bar.

2 Click Security.
3 Under the Access to Tenant Configuration section, click Add Users.
4 Leave the Grant access to all users in all target environments check box empty.
5 Select the target environment for the tenant.
6 Enter a specific user (email address or SAM account name) or enter a distribution group for all the users to
be granted access.
7 Click Add.and click Save.

Granting users access to data

The Security settings allow you to grant users access to data that is displayed in the insights. You can grant
access (aggregate or unrestricted) to the different types of collected data such as:
▪ cross platform usage
▪ Exchange mail client connectivity data (ActiveSync and OWA)
▪ Exchange message data
▪ Exchange DLP data

Unified Communications Analytics 8.5 Deployment Guide

45
Configuring UC Analytics
 ▪ Skype for Business/Lync usage data
▪ Skype for Business/Lync QoE data
▪ Cisco usage data
You can grant access to all users in all target environments or grant access to specific users in a specific target
environment.

About target environments

If you have configured additional forests or an Office 365 target environment (for a native Office 365 deployment),
when you click Add Users to grant access to a specific type of data, you must select the target environment (an
Active Directory forest or an Office 365 site) for the users.
For the users who are being granted access:
• You can grant aggregate access and/or unrestricted access.
• You can grant access to all users in all target environments or grant access to specific users in a specific
target environment.
When granting access to specific users, you can enter either an individual user or a distribution group. If
you selected Office 365 as the target environment, it is not recommended that you enter a dynamic
distribution group or a distribution group with a large number of members due to performance issues.

To grant data access to users

1 Click the gear icon on the home page side bar.

2 Click Security.
3 To grant access to a specific type of data, click Add Users in the section for that type of data.

TIP: When granting access to specific users, you can enter an individual user or a distribution group.
If you selected Office 365 as the target environment, it is not recommended that you enter a dynamic
distribution group or a distribution group with a large number of members due to performance issues.

4 Specify if the users have aggregate access or unrestricted access to each type of data.
For information about the differences between aggregate or unrestricted access to data, see Differences
between aggregate and unrestricted access on page 49.
5 If you want to grant access to all users, select the Grant access to all users in all target environments
check box.
- OR -
Enter a specific user (email address or SAM account name) or enter a distribution group for all the users to
be granted access.

IMPORTANT: For deployments with multiple target environments, if you are specifying a specific
user or distribution group, ensure that the displayed target environment is the environment for which
the user or group has rights. If necessary, select the correct environment from the dropdown list.

6 Click Add.
7 Click Save.
Unlike a product administrator who has access to the configuration settings for all environments (tenants), a tenant
administrator can only configure settings for a specific environment.

Unified Communications Analytics 8.5 Deployment Guide

46
Configuring UC Analytics
To grant access to specific types of data
Security settings allow you to grant users access to specific types of collected data. The types of data are grouped
into separate categories which reflect the insights in which the data is shown.
By default, all aggregate access is granted to everyone for all types of data. For information about the difference
between aggregate and unrestricted access to data, see Differences between aggregate and unrestricted access
on page 49.

TIP: If you do not have access to a certain insight (appears dimmed in the insight library) and you want to
know what type of access is required to see the insight, click the Launch Default button for the insight. A
message is displayed that indicates what type of data access is required to view data in the insight.

Cross-Platform Data
For cross-platform data, you can grant the following access to the aggregated and unrestricted data:

Table 15. Types of access that can be granted for Cross-Platform Data.

If I have this type of

I can see
access
Aggregate Summary (aggregate) information about the collected messages from
Exchange and about the Skype for Business/Lync peer-to-peer sessions and
conferences.
This access does not include details about individual messages or about
individual sessions and conferences.
Unrestricted Unrestricted access to the details of all the messages that everyone has sent
or received in all the targeted mailboxes, and details about all the sessions
and conferences in which the targeted users participated.
It is recommended that this access be granted only to select personnel.

Exchange Mail Client Connectivity (ActiveSync and OWA)

For Exchange mail client connectivity data, you can grant users access to information about how users are
connecting to Exchange using ActiveSync and OWA. You can set aggregate or unrestricted access.

Table 16. Types of access that can be granted for Exchange Mail Client Connectivity (ActiveSync
and OWA) Data.

If I have this type of

I can see
access
Aggregate Summary information about ActiveSync and OWA activity such as shown in
the ActiveSync - Server Activity, ActiveSync - User Activity, Outlook on the
Web (OWA) - Activity. or Outlook on the Web (OWA) vs. ActiveSync Unique
Usage insights.
Unrestricted Unrestricted grants access to detailed information about ActiveSync and
OWA activity, such as shown in the Outlook on the Web (OWA) - Logon
Details and the ActiveSync - Event Details insights.
It is recommended that this access be granted only to select personnel.

What insights are affected by the Exchange Mail Client Connectivity security
settings?
The Exchange Mail Client Connectivity security setting is used to grant access to all OWA insights and to
ActiveSync insights that show ActiveSync event activity. These insights are as follows:
• ActiveSync - Event Details

Unified Communications Analytics 8.5 Deployment Guide

47
Configuring UC Analytics
 • ActiveSync - Server Activity
• ActiveSync - User Activity
• Exchange ActiveSync / Servers / Server Activity
• Exchange ActiveSync / Servers / Server Sync Times
• Exchange ActiveSync / Users / Email Activity / Attachments
• Exchange ActiveSync / Users / Top Email Senders and Receivers
• Outlook on the Web (OWA) - Logon Details
• Outlook on the Web (OWA) - Activity
• Outlook on the Web (OWA) vs. ActiveSync Unique Usage
Not all ActiveSync insights are affected by the Exchange Mail Client Connectivity security settings. Security for
some ActiveSync insights is set using the Exchange Message Data settings. For example, access to insights that
show ActiveSync inventory or message data is granted using the Exchange Message Data settings. These
insights are as follows:
• Mobile Devices - Inactive
• Mobile Devices - Inventory
• Mobile Devices - Summary
• Exchange ActiveSync / Devices / Active Devices
• Exchange ActiveSync / Devices / Inactive Devices
• Exchange ActiveSync / Devices / Inventory / Device Inventory
• Exchange ActiveSync / Users / Email Activity / Departmental Summary
• Exchange ActiveSync / Users / Email Activity / Summary

Exchange Message Data

For Exchange message data, you can allow users to see aggregated information about email messages or
detailed data about the messages.

Table 17. Types of access that can be granted for Exchange Message Data.

If I have this type of

I can see
access
Aggregate Summary (aggregate) information about the collected messages and public
folder statistics. This access does not include details about individual
messages or information that is considered “private”.
Unrestricted Unrestricted access to the details of all the messages that everyone has
sent or received in all the targeted mailboxes.
It is recommended that this access be granted only to select personnel.

Exchange DLP Data

For Exchange DLP policy rule match data, you can provide separate access for users:

Table 18. Access that can be granted for Exchange DLP Data.

If I have this type of

I can see
access
Unrestricted Unrestricted access to all the individual DLP policy rule matches.
It is recommended that this access be granted only to select personnel.

Unified Communications Analytics 8.5 Deployment Guide

48
Configuring UC Analytics
Cisco Data
For Cisco usage data, you can provide separate access to users:

Table 19. Access that can be granted for Cisco Data.

If I have this type of

I can see
access
Aggregate Summary (aggregate) information about Cisco usage data. This access does
not include details about individual peer-to-peer sessions and conferences.
Unrestricted Unrestricted access to all the detailed Cisco information for the individual
peer-to-peer sessions and conferences.
It is recommended that this access be granted only to select personnel.

Skype for Business/Lync Data

For Skype for Business/Lync configuration and Skype for Business/Lync session, enterprise voice, and conference
data, there are different types of access that can be granted to users:

Table 20. Types of access that can be granted for Skype for Business/Lync Data.

If I have this type of

I can see
access
Aggregate Summary (aggregate) information about Skype for Business/Lync sessions
and conferences. This security access does not include details about
individual sessions and conferences.
Unrestricted Unrestricted access to the details of all the Skype for Business/Lync
sessions and conferences in the data collected from the CDR database.
It is recommended that this access be granted only to select personnel.

Skype for Business/Lync Quality of Experience (QoE) Data

For Skype for Business/Lync Quality of Experience (QoE) data, you can provide separate access to users:

Table 21. Access that can be granted for Skype for Business/Lync Quality of Experience (QoE) data.

If I have this type of

I can see
access
Aggregate Summary (aggregate) information about Skype for Business/Lync QoE data.
This access does not include details about individual calls, sessions, and
conferences.
Unrestricted Unrestricted access to all the detailed QoE information for the individual
calls, sessions, and conferences.
It is recommended that this access be granted only to select personnel.

Differences between aggregate and

unrestricted access
If you have aggregate access to data, you can view “public” information in insights. Public information is
information that does not specifically identify both individuals in a messaging transaction or does not include
“private” information such as message subject, file attachment name, or message ID. If you are collecting
message body information, the message body is also considered private.

Unified Communications Analytics 8.5 Deployment Guide

49
Configuring UC Analytics
Other information is considered “sensitive” and may be available for aggregate access depending on the filters you
have set in the insight. Sensitive information can include information such as: file attachment extensions, subject
keywords, participants, send and received time of day, and importance.
Though you can view sensitive information with aggregate access, sensitive information is not available for
specific individuals unless you have unrestricted access. Generally, with aggregate access, you can view insights
that contain one sensitive item but not two or more sensitive items.
For example, if you have aggregate access to data, you can view insights that contain information to answer
questions such as:
• How many emails were sent and received by your organization and who are the top senders?
• Which mail-enabled groups have not been active lately?
• How many emails were sent with file attachments of specific extensions and how big were they?
However, you cannot view an insight that shows private information that answers questions such as:
• What are the number of messages sent from one specific person to another specific person?
• What is the size of a specific mailbox and its last logon date?
• What are the number of messages from a department that contained a specific message subject?
However, you can see the number of messages from a department that contain a specific subject keyword.
• Which sent messages had a specific file attachment (such as “purchase.docx”)?
To see detailed and private information in insights, you must have a security access of Unrestricted for the type of
data reported in the insight.
For information about hiding certain insights from users, or only showing certain insights to some users, see
Setting insight visibility settings on page 105.

Accessing the UC Analytics web site

You access the insights through the UC Analytics home page at the following web site:
http://<ServerName>/Analytics/

NOTE: If UC Analytics is configured for a native Office 365 environment, you will be prompted for your
credentials. You can specify either your Windows credentials or your Office 365 credentials, depending on
how UC Analytics was configured to for user authentication. For more information, see Adding a target
environment for native Office 365.

On the Welcome page, you have the option of either

• viewing a set of recommended insights
• accessing the insight library so you can select the insights you want

To view the list of all available insights, click the library icon . home page side bar.

Changing your formats for date, time, and digit

separators
By default, the UC Analytics date and time formats are set to month/day/year (M/d/yyyy) and hour:minute:seconds
am or pm (h:mm:ss tt) for each user. When displaying numeric values, UC Analytics uses a period (.) for decimal
values and a comma (,) as digit separators for thousands.
Each user can modify these settings to match their locale. These settings are configured per user. An
administrator cannot set these values for all users.

Unified Communications Analytics 8.5 Deployment Guide

50
Configuring UC Analytics
To modify format settings
1 On the UC Analytics web site, click your user name that is displayed in top right corner.
2 Select User Profile.

3 Beside the Date Format or Time Format field, click and select the format you want.
4 Enter the values you want for the Decimal Separator and the Thousand Separator fields.
5 Click Save.

Overriding the time zone offset

UC Analytics determines the time zone that is used for scheduling and insights from the regional settings of the
computer that is running the user browser. You can override the time zone that is used through your user profile.

To override the time zone setting

1 On the UC Analytics web site, click your user name that is displayed in top right corner.
2 Select User Profile.
3 Click the Use Specific button in the Time zone section.
4 In the field below, enter the value for the specific time zone offset that you want. For example, you might
enter -5 or +2.
5 Click Save.
These settings are configured per user. An administrator cannot set these values for all users.

Unified Communications Analytics 8.5 Deployment Guide

51
Configuring UC Analytics
 4
Adding data sources for Active
Directory or Azure Active Directory
• Adding data sources for different target environments
• Permissions needed to collect Active Directory data
• Adding data sources for Active Directory / Office 365 (hybrid)
• Creating an Domain Controller data source
• Creating a data source for Office 365 user subscription configuration
• Adding data sources for native Office 365

Adding data sources for different target

environments
Depending on the target environment, you can add different data sources to collect information from either on-
premise Active Directory or Azure Active Directory.
• If you are collecting from on-premise Active Directory or a hybrid Office 365 deployment in an Active
Directory Forest / Office 365 (hybrid) target environment, you can add the following data sources:
▪ Domain Controller
▪ Office 365 User Subscription Configuration
• If you are collecting from a Azure Active Directory in an Office 365 (native) target environment, you can add
the following data sources:
▪ Office 365 User Subscription Configuration
For information about adding target environments, see Adding multiple Active Directory forests on page 31 and
Adding a target environment for native Office 365 on page 34.

Permissions needed to collect Active

Directory data
To collect data from on-premise Active Directory or Azure Active Directory, you add different data sources to gather
information. For each data source, you must specify the credential that is used to collect the data.
In most collections, you have the option to use the credential that is specified for the Data Engine service. If you
want to use that credential for your data collections, ensure it has the permissions specified for that data source.

Unified Communications Analytics 8.5 Deployment Guide

52
Adding data sources for Active Directory or Azure Active Directory
Permissions needed for the Domain Controller
data source
By default, a target environment is configured for the Active Directory forest in which UC Analytics is installed. In
the Active Directory Forest / Office 365 (hybrid) environment, you create a Domain Controller data source to
collect on-premise Active Directory data.
The credentials that you must specify to collect the Active Directory data have the following permissions:
• Read permissions on all the Active Directory user, group and contact objects
Alternately, when you add a Domain Controller data source, you can choose to use the Data Engine service
credentials if these credentials have read permissions on the Active Directory user objects. You specify the Data
Engine credentials during installation.

Permissions needed for the Office 365 user

subscription configuration data source
The Office 365 User Subscription data source data source collects the user subscription information for either a
native or a hybrid Office 365 implementation including licenses and subscribed services such as Exchange Online,
Skype for Business Online, SharePoint Online, etc.
The credentials that you specify to collect native Office 365 user subscription configuration are used to connect to
Azure Active Directory using remote PowerShell. The credentials must:
• Have Azure Active Directory PowerShell access enabled.
Additional software prerequisites must be met if you want to collect Office 365 user subscription information. For
more information, see the Software Requirements in the UC Analytics Release Notes.

Adding data sources for Active

Directory / Office 365 (hybrid)
If you have an Active Directory on-premise or hybrid environment, there are two data sources that you can
configure:
• Domain Controller which collects information about users, groups, and mail contacts from Active Directory
using LDAP. See Creating an Domain Controller data source on page 54.
• Office 365 User Subscription Configuration which retrieves Office 365 user subscription information
including licenses and services provisioning status. See Creating a data source for Office 365 user
subscription configuration on page 55.

Unified Communications Analytics 8.5 Deployment Guide

53
Adding data sources for Active Directory or Azure Active Directory
Creating an Domain Controller data source
When you create a data collection for Active Directory, you configure the Domain Controller data source. The data
collection collects information about users, groups, and mail contacts from Active Directory using LDAP.
If you have created more than one Active Directory forest target environment, remember to add a Domain
Controller data source for each environment.
By default, the Domain Controller data source collects only direct members of groups. For example, if a distribution
group contained 10 users and 14 distribution groups, the number of direct members would be counted as 24.
If you want to collect the effective members (direct and indirect) for a group you can use the Advanced settings in
the Collect Effective (Direct and Indirect) Members for Groups section. For example, if you collect from a
distribution group that has 10 user members and one distribution group member (that has 20 members), the
number of direct members is 11 but the number of effective members is 30.
You can also restrict the data collection to collect from specific organizational units (OUs).

To set up an Active Directory collection

1 Click the gear icon on the home page side bar.

2 Click Data Collection.
3 Click + beside the name of the target environment.
4 Select the Domain Controller check box.
5 Click the Domain Controller tile to open the configuration page.
6 Enable the data collection for the data source.
Data to collect
7 Select the types of data that you want to collect.
▪ Users
▪ Distribution Groups (static distribution groups and security groups
▪ Mail Contacts
▪ Dynamic Distribution Groups
▪ Direct Members
By default, the data source collection gathers direct members of standard distribution and security groups.
If you want to also collect direct members for dynamic distribution groups, select the Direct Members
check box under the selected Dynamic Distribution Groups check box.
8 Specify the credentials to be used by LDAP to collect from Active Directory.
If the Data Engine service credentials have read permissions on the Active Directory user objects, you can
use Data Engine service account to collect from Active Directory.
Targets
9 Select the targets of the data collection:
▪ All Active Directory objects
- OR-
▪ Active Directory objects within specific organizational units (OUs)
Advanced settings (not required for most deployments)
▪ If you want to change the minimum interval between the data collection runs or change the Data
Engine (Collector) server to be used for the data source, click Show Advanced Settings in the
Scheduling section.

Unified Communications Analytics 8.5 Deployment Guide

54
Adding data sources for Active Directory or Azure Active Directory
 ▪ If you want to specify one or more explicit domain controllers instead of automatically discovering
the domain controller, click Show Advanced Settings in the LDAP Collection Parameters section.
For more information, see Specifying explicit domain controllers for LDAP connections on page 38.
The domain controller must be a global catalog server.
▪ By default, the Domain Controller data source collects direct members of groups. If you want to
collect effective members (direct and indirect) for groups, click Show Advanced Settings in the
Collect Effective (Direct and Indirect) Members for Groups section. You can select to collect
effective members for specified groups or for all groups.
If you select Effective members for specific groups and click Add group, you have the option to
add each group individually or you can enter a list of groups, each entry separated by a semi-colon
(;).

IMPORTANT: If you collect effective membership for many groups, it can have significant
impact on performance and storage requirements.

10 Click Save.
For information about creating Domain Controller data sources for a resource forest configuration, see Configuring
UC Analytics for resource forests on page 32.

Creating a data source for Office 365 user

subscription configuration
The Office 365 user subscription configuration data source is used to gather Office 365 user subscription
information including licenses and service provisioning status using remote PowerShell. You can create the data
source for both native and hybrid Office 365.
• For a hybrid Office 365 implementation, you add the Office 365 user subscription configuration data source
in an Active Directory Forest / Office 365 (hybrid) target environment.
• For a native Office 365 implementation, you add the Office 365 user subscription configuration data source
in an Office 365 (native) target environment.
NOTE: Office 365 data sources are not displayed in the Data Collection page until you have added
Office 365 as a target environment. For more information, see Adding a target environment for native
Office 365 on page 34.

For more information about credential prerequisites, see Permissions needed for the Office 365 user subscription
configuration data source on page 53.

To set up an Office 365 user subscription configuration collection

1 Click the gear icon on the home page side bar.

2 Click Data Collection.
3 Click + beside the name of either an Active Directory / Office 365 (hybrid) target environment or an Office
365 (native) target environment.
4 Select the Office 365 User Subscription Configuration check box.
5 Click the Office 365 User Subscription Configuration tile to open the configuration page.
6 Enable the data collection for this data source.
7 Select the data that you want to collect.
8 Specify the Office 365 credential used to collect the user configuration data through PowerShell.
Advanced settings (not required for most deployments)

Unified Communications Analytics 8.5 Deployment Guide

55
Adding data sources for Active Directory or Azure Active Directory
 ▪ If you want to change the minimum interval between the data collection runs or change the Data
Engine (Collector) server to be used for the data source, click Show Advanced Settings in the
Scheduling section.
9 Click Save.

Adding data sources for native Office

365
If you have a native Office 365 environment, there are one data source that you can configure to collect from
Azure Active Directory using remote PowerShell:
• Office 365 User Subscription Configuration which retrieves Office 365 user subscription information
including licenses and services provisioning status.
For information about how to configure the Office 365 User Subscription Configuration data source, see
Creating a data source for Office 365 user subscription configuration on page 55.

Unified Communications Analytics 8.5 Deployment Guide

56
Adding data sources for Active Directory or Azure Active Directory
 5
Adding data sources, chargeback
costs, and thresholds for Exchange
and Exchange Online
• Permissions needed to collect Exchange on-premise or hybrid data
• Permissions needed to collect from native Exchange Online
• Creating a data source for Exchange configuration
• Creating a data source for Exchange tracking logs
• Creating a data source for Exchange mailbox contents
• Do I need both Exchange tracking log and Exchange mailbox contents collections?
• Creating a data source for Exchange IIS Logs
• Creating a data source for Exchange mailbox content summary
• Creating a data source for Exchange public folders
• Adding Exchange Online hybrid data sources for hybrid Office 365
▪ Creating a data source for Exchange Online hybrid user configuration
▪ Creating a data source for Exchange Online hybrid mailbox configuration
▪ Creating a data source for Exchange Online mailbox contents data source
▪ Creating a data source for Exchange Online mailbox content summary data source
• Adding Exchange Online data sources for native Office 365
▪ Creating a data source for Exchange Online native user configuration
▪ Creating a data source for the Exchange Online native mailbox configuration data source
▪ Creating a data source for Exchange Online mailbox contents data source
▪ Creating a data source for Exchange Online mailbox content summary data source
• Setting chargeback costs for Exchange
• Setting thresholds for Exchange metrics
• Omitting words when filtering by subject or body

Unified Communications Analytics 8.5 Deployment Guide

57
Adding data sources, chargeback costs, and thresholds for Exchange and Exchange Online
Permissions needed to collect
Exchange on-premise or hybrid data
To collect data from Exchange, you add different data sources to gather information. For each data source, you
must specify the credential that is used to collect the data. In most collections, you have the option to use the
credential that is specified for the Data Engine service. If you want to use that credential for your data collections,
ensure it has the permissions specified for that data source.
By default, a target environment is configured for the Active Directory forest in which UC Analytics is installed.
In the Active Directory forest environment, you can create the following data sources to collect data from both on-
premise Exchange and hybrid Exchange Online:
• Exchange Configuration: This data source collects Exchange configuration and mailbox properties using
PowerShell and Active Directory LDAP queries. For information about the required permissions, see
Permissions needed for the Exchange configuration data source on page 59.
• Exchange Tracking Logs: This data source collects message traffic and DLP rule match data from the
Exchange tracking logs. For information about the required permissions, see Permissions needed for the
Exchange tracking logs data source on page 59.
• Exchange Mailbox Contents: This data source collects mailbox contents from on-premise Exchange
using Exchange Web Service (EWS). For information about the required permissions, see Permissions
needed for Exchange mailbox contents or Exchange mailbox content summary data sources on page 60.
• Exchange IIS Logs: This data source collects ActiveSync information about ActiveSync mobile devices
from IIS logs. Also used to collect Outlook in the Web (OWA) logon details. For information about the
required permissions, see Permissions needed for the Exchange IIS logs (ActiveSync and OWA) data
source on page 60.
• Exchange Mailbox Content Summary: This data source collects mailbox folder statistics including size,
item count, and number of subfolders using LDAP and Exchange Web Services (EWS) for mailbox folders
such as the Outbox, Deleted Items, Junk E-Mail. For information about the required permissions, see
Permissions needed for Exchange mailbox contents or Exchange mailbox content summary data sources
on page 60.
• Exchange Public Folders: This data source collects legacy public folder data from Exchange 2010 and
new public folder data from Exchange 2013 and Exchange 2016. For information about the required
permissions, see Permissions needed for the Exchange public folders data source on page 61.
• Exchange Online Hybrid User Configuration: This data source collects detailed information about users
and distribution groups in a hybrid environment using remote PowerShell. See Permissions needed for the
Exchange Online hybrid user configuration data source on page 61.
For a native Office 365 implementation, use the Exchange Online Native User Configuration data source.
• Exchange Online Hybrid Mailbox Configuration: This data source collects Exchange Online mailbox
statistics such as mailbox size, permissions, and mobile devices from hybrid (on-premise and Office 365)
environments. For information about the required permissions, see Permissions needed for the Exchange
Online hybrid mailbox configuration data source on page 61.
For a native Office 365 implementation, use the Exchange Online Native Mailbox Configuration data
source.
• Exchange Online Mailbox Contents: This data source collects mailbox content information from hybrid or
native Office 365 using Exchange Web Services (EWS). For information about the required permissions,
see Permissions needed for Exchange Online mailbox contents data on page 62.
• Exchange Online Mailbox Content Summary: This data source collects mailbox folder statistics
including size, item count, and number of subfolders, from hybrid or native Office 365 using Exchange Web
Services (EWS). For information about the required permissions, see Permissions needed for Exchange
Online mailbox content summary data on page 62.

Unified Communications Analytics 8.5 Deployment Guide

58
Adding data sources, chargeback costs, and thresholds for Exchange and Exchange Online
About adding an account to an Exchange role group
When the credential used in a data source must be a member of an Exchange role group, it is important to add the
account to the role group correctly. If you simply add a user to a group using Active Directory Users & Computers,
(ADUC) utility, the user is not granted the full rights of the Exchange group role. In this case, the data source
permissions are not met.
To provide the full grant of an Exchange admin role group to an account, you must use the PowerShell Exchange
cmdlet Add-ExchangeAdministrator or the Exchange Admin Center (EAC).

Permissions needed for the Exchange

configuration data source
The credentials that are used to collect Exchange configuration and mailbox properties through PowerShell and
LDAP must be a member of specific security groups.
For Exchange 2010-only, Exchange 2013-only, or Exchange 2016-only environments, or Exchange mixed
environments, the credential must:
• Be a member of the Public Folder Management role group or Organization Management role group. (The
View-Only Organization Management role group is not sufficient.)

NOTE: If you require information about database copies, ensure that the LDAP connection credential has
read permissions to ms-Exch-MDB-Copy objects in Active Directory:
• To grant permissions directly, modify permissions in Active Directory.
• To grant permissions indirectly, add the credential to either the Exchange Organization Management
or the Exchange Public Folder Management role group.

Permissions needed for the Exchange tracking

logs data source
For Exchange tracking logs, the specified credentials are used to collect message traffic and DLP incident data
from the Exchange message tracking logs. (DLP data is collected only for Exchange 2013 and later.) The
credentials must:
• Have access rights to the share that contains the Exchange message tracking logs
• Be a member of the View-Only Organization Management security group
• Be a member of the Public Folder Management security group
You can gather Exchange message tracking logs from any of the following locations:
• Directly from tracking log folders on each Exchange server
• From user-created file shares on each Exchange server, such as \\ServerName\MessageTracking
• From any file share that contains up-to-date Exchange tracking log copies. Original log files and
compressed zip files (using either WinZip or Windows native compressed format) are supported.
For information about gathering historical tracking logs from a centralized location, see About collecting historical
tracking logs on page 69.

Unified Communications Analytics 8.5 Deployment Guide

59
Adding data sources, chargeback costs, and thresholds for Exchange and Exchange Online
Default locations for tracking logs
By default, the Exchange tracking log folder is located as follows:
• Exchange 2010
\\ServerName\c$\Program Files\Microsoft\Exchange Server\V14\TransportRoles\Logs\MessageTracking
• Exchange 2013
\\ServerName\c$\Program Files\Microsoft\Exchange Server\V15\TransportRoles\Logs\MessageTracking
• Exchange 2016
\\ServerName\c$\Program Files\Microsoft\Exchange Server\V15\TransportRoles\Logs\MessageTracking

Permissions needed for Exchange mailbox

contents or Exchange mailbox content
summary data sources
Any credentials that are used to collect Exchange mailbox contents or Exchange mailbox content summary using
Exchange Web Services (EWS) must have “Exchange Impersonation” permissions to all the target mailboxes:
• For information about how to set Exchange impersonation for Exchange 2013 or Exchange 2016, see
Setting impersonation for Exchange 2013 or Exchange 2016 on page 115.
• For information about how to set Exchange impersonation for Exchange 2010, see the Microsoft article:
Configuring Exchange Impersonation.
• For information about how to set impersonation for Exchange Online (Office 365), see Setting
impersonation for Office 365 on page 116.
The credential used to connect to a domain controller through LDAP must have access to user and group
configuration information.

Permissions needed for the Exchange IIS logs

(ActiveSync and OWA) data source
When you configure an Exchange IIS logs data source, you specify two sets of credentials:
• credentials for the LDAP connection to Active Directory
• credentials for collecting the IIS log files from the Exchange CAS (Client Access Services)

Credentials to collect data through LDAP

The credentials that are used to collect device and user information through LDAP from Active Directory must
have the following Active Directory permissions:
• Must have read permissions for Active Directory user, domain, and Exchange server objects.
• Must have read permission on the msExchMailboxGuid property of all user objects.
Usually, these read permissions are available to members of the Authenticated Users group. Consequently, you
only need to be an authenticated user of the domain or of another domain that is trusted by the domain.

Unified Communications Analytics 8.5 Deployment Guide

60
Adding data sources, chargeback costs, and thresholds for Exchange and Exchange Online
Credentials to collect the IIS log files
The credentials that are used to collect information from the IIS log files on the Exchange Client Access Server
(CAS) must have the following permissions:
• Local Administrators rights on all Exchange CAS servers
The Local Administrators rights are required to access to the IIS logs through an administrative volume share,
such as C$.
As an alternative to providing Local Administrators rights, you could create a non-administrative share for the IIS
log folder. You could then grant read access to the credentials to the IIS log files through the share.
Also, IIS logging must be configured on the Exchange CAS servers. For more information, see Appendix C:
Configuring IIS Log Files to capture ActiveSync or OWA events on page 121.

Permissions needed for the Exchange public

folders data source
When you configure an Exchange public folders data source, you can select whether you want to collect data from
legacy public folders (Exchange 2010) or new (Exchange 2013, Exchange 2016) public folders.
For Exchange 2010, Exchange 2013, or Exchange 2016 the credentials that you specify to collect public folder
data using remote PowerShell must:
• Be a member of the Exchange View-Only Administrator role.
• Have remote PowerShell access enabled.

Permissions needed for the Exchange Online

hybrid user configuration data source
You would create an Exchange Online hybrid user configuration data source only if you have an Exchange/Office
365 hybrid environment. The credentials that you specify to collect Active Directory user data using LDAP must
have the following permissions:
• Read permissions on all the Active Directory user objects.
The credentials that you specify for Exchange Online PowerShell to collect user data using remote PowerShell
and must have the following permissions:
• Be a member of the Exchange View-Only Organization Management role in the Exchange Online tenant.
• Have PowerShell access enabled.

Permissions needed for the Exchange Online

hybrid mailbox configuration data source
The credentials that you specify to collect Active Directory user data using LDAP must have the following
permissions:
• Read permissions on all the Active Directory user objects.
The credentials that you specify to connect to Exchange Online using remote PowerShell must:
• Be a member of the Exchange View-Only Organization Management role in the Exchange Online tenant.
• Have PowerShell access enabled.

Unified Communications Analytics 8.5 Deployment Guide

61
Adding data sources, chargeback costs, and thresholds for Exchange and Exchange Online
 • Have sufficient permissions to run the Azure AD cmdlet Get-MsolUser (This permission is not required if
you are using the Azure AD Connect synchronization method with Exchange 2016.)
To collect mailbox recipient “send as” permissions, the credentials must also:
• Be a member of the Recipient Management role group in the Exchange Online tenant.

Permissions needed for Exchange Online

mailbox contents data
The Exchange Online mailbox contents data source can be configured to collect in either hybrid or native Office
365 deployments.
• To configure the data source to collect in a hybrid deployment, you must add the data source in an Active
Directory Forest/Office 365 Hybrid target environment.
• To configure the data source to collect in a native Office 365 deployment, you must add the data source to
an Office 365 (native) target environment.
The credentials that you specify to collect Exchange Online mailbox contents data using EWS must:
• Have Exchange impersonation permissions for all the Exchange Online target mailboxes.
• Have Exchange Web Services (EWS) access enabled.
• Be a member of the Exchange View-Only Organization Management role in the Exchange Online tenant.
• Have PowerShell access enabled.

Permissions needed for Exchange Online

mailbox content summary data
The Exchange Online mailbox contents and the Exchange Mailbox Content Summary data sources can be
configured to collect in either hybrid or native Office 365 deployments.
• To configure the data source to collect in a hybrid deployment, you must add the data source in an Active
Directory Forest/Office 365 Hybrid target environment.
• To configure the data source to collect in a native Office 365 deployment, you must add the data source to
an Office 365 (native) target environment.
The credentials that you specify to collect Exchange Online mailbox folder data using EWS must:
• Have an Exchange Online mailbox.
• Have Exchange impersonation permissions for all the Exchange Online target mailboxes.
• Have Exchange Web Services (EWS) access enabled.

Unified Communications Analytics 8.5 Deployment Guide

62
Adding data sources, chargeback costs, and thresholds for Exchange and Exchange Online
Permissions needed to collect from
native Exchange Online
If you have a native Office 365 target environment, you can create the following data sources to collect information
from your native Exchange Online deployment. You must set up an Office 365 (native) target environment and
specify the required credentials when you configure the Exchange Online data sources.
• Exchange Online Native User Configuration: This data source collects user and distribution group data
using remote PowerShell. For information about the required permissions, see Permissions needed for
Exchange Online native user configuration data source on page 63.
• Exchange Online Native Mailbox Configuration: This data source collects Exchange Online native
mailbox statistics such as mailbox size, permissions, and mobile devices. For information about the
required permissions, see Permissions needed for Exchange Online native mailbox configuration on page
63. For a hybrid Office 365 implementation, use the Exchange Online Hybrid Mailbox Configuration data
source.
• Exchange Online Mailbox Contents: This data source can collect mailbox content information from either
hybrid or native Office 365 using Exchange Web Services (EWS). For information about the required
permissions, see Permissions needed for Exchange Online mailbox contents data on page 62.
• Exchange Online Mailbox Content Summary: This data source can collect mailbox content information
from either hybrid or native Office 365 using Exchange Web Services (EWS). For information about the
required permissions, see Permissions needed for Exchange Online mailbox content summary data on
page 62,

Permissions needed for Exchange Online

native user configuration data source
The Exchange Online Native User Configuration data source collects user and distribution group data using
remote PowerShell. The credentials that you specify are used to collect user configuration data using remote
PowerShell from native Office 365. The credentials must:
• Be a member of the Exchange View-Only Organization Management role in the Exchange Online tenant.
• Have PowerShell access enabled.

Permissions needed for Exchange Online

native mailbox configuration
The credentials that you specify to collect Exchange Online native mailbox configuration data (including statistics,
permissions, and mobile devices) using remote PowerShell must:
• Be a member of the Exchange View-Only Organization Management role in the Exchange Online tenant.
• Have PowerShell access enabled.
To collect mailbox recipient “send as” permissions, the credentials must also:
• Be a member of the Recipient Management role group in the Exchange Online tenant.

Unified Communications Analytics 8.5 Deployment Guide

63
Adding data sources, chargeback costs, and thresholds for Exchange and Exchange Online
Creating a data source for Exchange
configuration
The Exchange configuration data collection gathers information about the Exchange hierarchy such as
organizations, servers, DAGs, database status, database copies, and mailbox properties through PowerShell and
LDAP queries to Active Directory.
When you configure an Exchange configuration collection, you specify the LDAP connection credentials, target
mailboxes, the Exchange server from which you want to collect, and remote PowerShell connection details.

Why should I specify target mailboxes?

If you specify target mailboxes, mailbox statistical and configuration information is also collected for those
mailboxes including:
• Mailbox configuration (quotas, home database)
• Mailbox statistics (size, Item counts, deleted Item counts, storage status, and last logon time)
• Mobile devices associated with the mailbox (device model, device type, first sync time, last sync time,
policy update time)
• Mailbox permissions and Active Directory extended permissions
• Archive mailbox (personal archive) statistics
This information is not collected for mailboxes that are not set as target mailboxes. You can set all mailboxes,
mailboxes for a specific mailbox server, mailboxes that belong to a specific organizational unit (OU), or specific
mailboxes as target mailboxes.

To set up an Exchange configuration collection

1 Click the gear icon on the home page side bar.

2 Click Data Collection.
3 Click + beside the name of the target environment.
4 Select the Exchange Configuration check box.
5 Enable the data collection for this data source.
6 Select the types of data that you want to collect.
Specifying LDAP connection parameters
7 Specify credentials to be used for the LDAP connection or select the Use Data Engine service credential
option. See Permissions needed for the Exchange configuration data source on page 59.
If you have an Exchange resource forest deployment
If you have an Exchange resource forest deployment, you must configure the options in the Account
Forest LDAP Connection Parameters section. This option is required only for linked mailboxes that have
the master accounts in a different forest.
a Select the Search additional forests for user accounts check box.
The options under Show advanced settings are expanded.
b Select the appropriate option for the Account Forest Domain Controller:
▪ Automatically discover domain controller in specific domain
▪ Use specific domain controller
c Specify the credentials that are used to access the domain controller using LDAP.

Unified Communications Analytics 8.5 Deployment Guide

64
Adding data sources, chargeback costs, and thresholds for Exchange and Exchange Online
 Click Add connection for each account forest that contains master accounts. This adds another section of
Account Forest LDAP Connection Parameters. Specify the domain controller information and credentials
for each forest.
Specifying target mailboxes
8 You have different options for specifying the target mailboxes to be included:
▪ Select all mailboxes.
▪ Specify the mailbox server for the mailboxes.
▪ Specify the organizational unit (OU) to which the mailboxes belong.
▪ Specify certain mailboxes that you want collected.
When specifying certain mailboxes you can enter the common name or email address of a mailbox,
a group. or a dynamic distribution group. For more information about using a dynamic distribution
group to specify target mailboxes, see Using dynamic distribution groups to select target mailboxes
on page 66.
Specifying PowerShell connection parameters
9 Specify the Exchange version from which you are collecting data. For a mixed environment, select the
latest version of Exchange that is installed.
For a mixed organization containing Exchange 2010 and Exchange 2013/2016 servers, select Exchange
2013/2016 to get the most comprehensive configuration data.
To collect from Exchange 2010, Exchange 2013, or Exchange 2016, you must
▪ Click Add server and enter the Client Access Services (CAS) server name (and port number if
applicable).
10 Specify the explicit credentials to be used to make the PowerShell connection.
Advanced settings (not required for most deployments)
▪ If you want to change the minimum interval between the data collection runs or change the Data
Engine (Collector) server to be used for the data source, click Show Advanced Settings in the
Scheduling section.
▪ If you want to specify one or more explicit domain controllers instead of automatically discovering
the domain controller, click Show Advanced Settings in the LDAP Collection Parameters section.
For more information, see Specifying explicit domain controllers for LDAP connections on page 38.
The domain controller must be a global catalog server.

NOTE: If the Data Engine is in a different forest from the data to be collected, specify the
domain controller you want to use for data collection. If you leave the default setting to
automatically discover domain controller, the data collector selects a domain controller from
the forest that hosts the Data Engine, not a domain controller from the forest from which you
are collecting the data.

▪ To use HTTPS instead of HTTP to connect to the Exchange 2010/2013/2016 CAS server, click
Show Advanced Settings in the PowerShell Connection Parameters section. This option requires
that TLS/SSL is enabled for remote PowerShell on the Exchange CAS server.
The Advanced Settings also provide options if you have a customized PowerShell virtual folder, or if
you want specify either an implicit credential or the Data Engine credential be used to make the
PowerShell connection.
11 Click Save.
For more information about credential prerequisites, see Permissions needed for the Exchange configuration data
source on page 59.
For information about creating Exchange Configuration data sources for a resource forest configuration, see
Configuring UC Analytics for resource forests on page 32.

Unified Communications Analytics 8.5 Deployment Guide

65
Adding data sources, chargeback costs, and thresholds for Exchange and Exchange Online
Best practices for gathering performance
To obtain the best performance from the Exchange configuration data collection, you can add several Exchange
configuration data sources to collect the data. Each data source would specify a different group of target users.
It is recommended that you group the target users according to the geographic location of the mailboxes. You can
add a separate data source to collect from each geographical area. Select the server hosting Client Access
Services (CAS) that is nearest to the mailbox server for each data source you configure.
In another example of distributing the data collection, you might want configure a separate Exchange configuration
data source to collect mailbox permissions data. You could configure one Exchange configuration data source to
collect mailbox permissions from a select number of target mailboxes. You could add another data source to
collect the rest of the data for the same mailboxes.
Once you have added multiple data sources for Exchange configuration data, you can name each data source to
reflect the information that is being collected. For information about renaming a data source, see Renaming a data
source on page 43.

Using dynamic distribution groups to select

target mailboxes
A dynamic distribution group includes any recipient in Active Directory with attributes that match the filter and
conditions that you have defined.
To group target users by geographic location, you can create multiple dynamic distribution groups. All the
mailboxes in each group would belong to same geographic location.
Suppose you have several data center locations within a global domain such as LON01, NYC01, and TKY01. You
would create multiple data sources, one for each location.
For example, the data source for LON01 site would use the dynamic distribution group that contains only
mailboxes from LON01 and would use a CAS server from LON01.

TIP: To create dynamic distribution group for mailboxes from a single location, you could use a filter based
on a mailbox custom attribute.
1 Run a PowerShell script to get all the mailbox databases.
2 Get the CAS server for each mailbox database.
3 Set the corresponding CAS server name to be one of the Custom Attributes for each mailbox.
4 After the attribute is set, use that Custom Attribute as a filter when you create dynamic distribution
groups.

Specifying recipient types for a dynamic distribution group

When you create a dynamic distribution group, you set the filters you determine which mailboxes and users will be
included. If you want the data collection to gather all user mailboxes, shared mailboxes, and resource mailboxes
you would select All recipient types.
You could select specific filters to include only certain types of users and mailboxes such as:
• Users with Exchange mailboxes
• Users with external email addresses
• Resource mailboxes
• Contacts with external email addresses
• Mail-enabled groups

Unified Communications Analytics 8.5 Deployment Guide

66
Adding data sources, chargeback costs, and thresholds for Exchange and Exchange Online
What types of mailboxes are excluded?
The Exchange Configuration and the Exchange Mailbox Content Summary data source collections do not include
the following types of mailboxes:
• Arbitration Mailbox
• Mailbox Plan
• Discovery Mailbox
• Public Folder Mailbox
• Monitoring Mailbox
• Audit Log Mailbox
• Mailboxes with a name that starts with "SystemMailbox{"
• Mailboxes with a name that starts with "CAS_{"

Can I enter the Domain Users group as the

target for the data collection?
When you specify target users for data collections, you can use distribution or security groups. However, UC
Analytics does not support the group Domain Users as a target group. Domain Users is a special Microsoft group
that does not contain a membership setting so UC Analytics cannot resolve it. UC Analytics supports all the groups
with membership information. You can check a group's membership setting using the ADSI Edit tool or ADAC
(Active Directory Administrative Center).
For Exchange configuration, the data collection gathers the configuration for mailboxes, not for users. For this
reason, it is not recommended that you use a group such as Domain Users that contains users without mailboxes,
mail contacts, and other types of recipients. The data collection will complete but it will be full of warnings in the job
details for every “not applicable” user.
When creating a group to use as a target, it is recommended you create a static group with a specified
membership or create a dynamic group. For a dynamic group, select the check boxes for users with Exchange
mailboxes. That will cover all the Exchange mailboxes in the organization. For static groups, use only groups that
have members with Exchange mailboxes and do not include any other kind of users.

Troubleshooting the Exchange configuration

collection
In some situations, if you are collecting mailbox properties from an Exchange server without using TLS/SSL, you
might see error messages such as the following:
“Connecting to remote server failed with the following error message: The WinRM client cannot process the
request. Unencrypted traffic is currently disabled in the client configuration. Change the client configuration and try
the request again. For more information, see the about_Remote_Troubleshooting Help topic.”
You must enable unencrypted traffic for the WinRM client. You can use the Local Group Policy Editor to modify the
WinRM client settings.

To enable unencrypted traffic

1 Click Start, type gpedit.msc in the Start Search box and press ENTER to open the Local Group Policy
Editor.
2 In the tree view, navigate to Local Computer Policy | Computer Configuration | Administrative Templates |
Windows Components | Windows Remote Management (WinRM) | WinRM Client.

Unified Communications Analytics 8.5 Deployment Guide

67
Adding data sources, chargeback costs, and thresholds for Exchange and Exchange Online
 3 Enable the following settings:
▪ Allow unencrypted traffic
▪ Trusted Hosts
4 Select the Trusted Hosts setting.
5 Enter the servers to which you want to connect in the Trusted Hosts list. Wild cards are accepted.

Creating a data source for Exchange

tracking logs
The Exchange tracking log collection gathers email message information for all mailboxes. You must gather the
Exchange message tracking logs from all Exchange hub transport servers and all Exchange mailbox servers. If
you have historical tracking logs stored in a central location, you can gather from those tracking logs as well. To
configure the Exchange tracking log data collection, you specify the following:
• the scope of the mailboxes data to be collected (all or specific OUs)
• the locations of the Exchange message tracking log shares from which you want to gather data
• the credentials used to access the tracking logs
For information about the permissions needed, see Permissions needed for the Exchange tracking logs data
source on page 59.

To set up an Exchange tracking log collection

1 Click the gear icon on the home page side bar.

2 Click Data Collection.

3 Click + beside the name of the target environment.
4 Select the Exchange Tracking Logs check box.
5 Enable the data collection for this data source.
Data to collect
6 Select the types of data that you want to collect.
▪ DLP (Data Loss Prevention) Matches (DLP data is collected only for Exchange 2013 and later.)
▪ Email Messages
LDAP Connection Parameters
7 Specify credentials to be used for the LDAP connection or select the Use Data Engine service credential
option.
Targets
8 Select whether you want to collect data for all Exchange mailboxes or for only the mailboxes in specified
organizational units (OUs).
Tracking Log Collection Parameters
9 Specify each folder location from which the tracking logs are to be gathered.
10 Specify the credentials that are used to gather the Exchange tracking logs.

Unified Communications Analytics 8.5 Deployment Guide

68
Adding data sources, chargeback costs, and thresholds for Exchange and Exchange Online
 Advanced settings (not required for most deployments)
▪ To change the minimum interval between the data collection runs or change the Data Engine
(Collector) server to be used for the data source, click Show Advanced Settings in the Scheduling
section.
▪ To specify one or more explicit domain controllers instead of automatically discovering the domain
controller, click Show Advanced Settings in the LDAP Collection Parameters section. For more
information, see Specifying explicit domain controllers for LDAP connections on page 38. The
domain controller must be a global catalog server.
If the Data Engine is in a different forest from the data to be collected, you must specify the domain
controller you want to use. If you automatically discover domain controller, the data collector selects
a domain controller from the forest that hosts the Data Engine, not a domain controller from the
forest from which you are collecting data.
11 Click Save.

About collecting historical tracking logs

Tracking logs from each Exchange server have the same file name format, so you must have a separate folder for
each server. Do not change the tracking log file names. The naming convention for the message tracking log files
is as follows:
MSGTRKyyyymmdd-nnnn.log
MSGTRKMAyyyymmdd-nnnn.log
MSGTRKMDyyyymmdd-nnnn.log
MSGTRKMSyyyymmdd-nnnn.log
When you configure the tracking log data collection, specify each folder from which you are gathering tracking
logs.The data collection job goes through the files each time it is scheduled to run (every hour by default).
However, the job reads only new changes (new files or files that have changed since the last time the job ran).
This method allows the data collection job to collect and update the data in a timely manner without reading the log
files multiple times.

Creating a data source for Exchange

mailbox contents
The Exchange mailbox contents data collection gathers email message information from user mailboxes using
Exchange Web Services (EWS). When you configure a mailbox contents data collection, you must specify the
target mailboxes and the Client Access Server (CAS) URL that is used to connect to the mailbox server. For
Exchange 2016, you specify the URL for the Client Access Services on the mailbox server.
When you specify target mailboxes, you can set all mailboxes, mailboxes for a specific mailbox server, mailboxes
that belong to a specific organizational unit (OU), or specific mailboxes as targets.

TIP: When specifying individual mailboxes as targets, it is recommended that you add the user mailboxes to
a distribution group. You can then add the distribution group for the target mailboxes.

If you have an Exchange hybrid environment, you can configure an Exchange Online Mailbox Contents data
source to collect Office 365 mailboxes. For more information, see Permissions needed for Exchange mailbox
contents or Exchange mailbox content summary data sources on page 60.
In addition to message traffic, you can configure the mailbox contents collection to gather the following message
information from the target mailboxes:
• Subject

Unified Communications Analytics 8.5 Deployment Guide

69
Adding data sources, chargeback costs, and thresholds for Exchange and Exchange Online
 • Body
• File attachments
• Localized send / receipt time of day (used to show “after hours” and “response time” data in insights)
• Internet Message Headers (provides technical details about the message, such as who sent it, the software
used to compose it, and the email servers that it passed through on its way to the recipient)
For information about how times are calculated on insights when you use the “response time” or “after hours”
filters, see the section titled How the Filters Work in the UC Analytics User Guide.

To set up an Exchange mailbox contents data collection

1 Click the gear icon on the home page side bar.

2 Click Data Collection.
3 Click + beside the name of the target environment.
4 Select the Exchange Mailbox Contents check box.
5 Enable the data collection for this data source.
6 Select the data to collect.
Recommendation
If you select Body or Internet Message Headers, it is recommended that you limit the number of mailboxes
to a key group of user mailboxes for this specific data collection.
Specifying the LDAP connection parameters
7 Specify the Windows credentials for the LDAP connection
- OR -
Select the Use Data Engine service credential option.
Specifying the target mailboxes
8 You have different options for specifying the target mailboxes to be included:
▪ Select all mailboxes.
▪ Specify the mailbox server for the mailboxes.
▪ Specify the organizational unit (OU) to which the mailboxes belong.
▪ Specify certain mailboxes that you want collected.
When specifying certain mailboxes you can enter the common name or email address of a mailbox,
a group. or a dynamic distribution group. For more information about using a dynamic distribution
group for target mailboxes, see Using dynamic distribution groups to select target mailboxes on
page 66.
Specifying data collection parameters for EWS connection
9 Select the versions of Exchange from which you want to collect data:
▪ Collect from mailboxes on all supported Exchange versions
▪ Specify a specific Exchange version from which you want to collect data.
10 Specify the credential used to collect the mailbox data. For more information see Permissions needed for
Exchange mailbox contents or Exchange mailbox content summary data sources on page 60.
11 Specify the URLs for the CAS (Client Access Servers or Client Access Services) to be used by Exchange
Web Services (EWS).
▪ Use Exchange auto-discovery for each mailbox

Unified Communications Analytics 8.5 Deployment Guide

70
Adding data sources, chargeback costs, and thresholds for Exchange and Exchange Online
 ▪ Specify the specific Exchange Web Services URLs
TIP: In many Exchange environments, Exchange auto-discovery does not always work so it is
recommended that you specify individual Exchange Web Services URLs.

When you specify the CAS for the EWS gathering, you must enter the URL for the server. For
example, the URL might be:
https://MyCASServer/ews/Exchange.asmx
You can specify multiple CAS URLs to be used for the EWS gathering. If you specify multiple CAS
URLs, data collection is faster. If you do not specify one or more CAS URLs, the Exchange
Autodiscover service is used to find the CAS servers for the target mailboxes.
Advanced settings (not required for most deployments)
▪ If you want to change the minimum interval between the data collection runs or change the Data
Engine (Collector) server to be used for the data source, click Show Advanced Settings in the
Scheduling section.
▪ If you want to specify one or more explicit domain controllers instead of automatically discovering
the domain controller, click Show Advanced Settings in the LDAP Collection Parameters section.
For more information, see Specifying explicit domain controllers for LDAP connections on page 38.
The domain controller must be a global catalog server.
If the Data Engine is in a different forest from the data to be collected, you must specify the domain
controller you want to use for data collection. If you leave the default setting to automatically
discover domain controller, the data collector selects a domain controller from the forest that hosts
the Data Engine, not a domain controller from the forest from which you are collecting the data.
12 Click Save.

Tips for better performance for mailbox

contents collection
You can specify more than one set of Exchange gathering credentials and you can specify more than one CAS
server for EWS data collection.
If you specify multiple EWS credentials and multiple CAS servers, it allows the EWS gathering to collect data from
more mailboxes in parallel. This will reduce the time that is needed to collect the data.
For information about the types of data collections and the rate at which message data is collected, see
Determining where to install services on page 17.
You could also increase the Exchange throttling quota for the accounts used to collect the message data.
IMPORTANT:
If you configure a mailbox content data gathering to collect the message body, storage requirements can be
doubled. It is strongly recommended that if you collect the message body, you specify only a limited number
of target mailboxes for this data collection.

How many CAS URLs and credentials are needed for

mailbox content data collection?
By increasing the number of CAS URLs and the number of credentials that are used for collection of the Exchange
data, you can shorten the time that it takes EWS to collect the message data.
Assuming that Exchange throttling is set to the default value for the gathering credentials, the estimated collection
times are as follows:
• The initial data collection is a collection that collects 30 days data from all the target mailboxes. Messages
that are older than 30 days are not collected even if they are still in the mailbox. You can expect a collection
rate of 25 mailboxes an hour per CAS server/credential pair set.

Unified Communications Analytics 8.5 Deployment Guide

71
Adding data sources, chargeback costs, and thresholds for Exchange and Exchange Online
 You can change the number of days for the initial data collection period when you configure the connection
on the Data Collection page under Admin Settings.
• After the initial collection, each subsequent collection is an ongoing collection in which only new or changed
messages are collected. The ongoing collection runs every 30 minutes. Collection times decrease and you
can expect a collection rate of 100 mailboxes an hour per CAS server/credential pair set.

Do I need both Exchange tracking log

and Exchange mailbox contents
collections?
Though the mailbox contents data collection and the Exchange tracking log data collection both gather message
information, there are some differences.

Table 22. Comparison of Exchange tracking log and mailbox contents collections

Exchange tracking log data collection Exchange mailbox contents data collection
The Exchange tracking log collection gathers The mailbox contents collection gathers message
message information for all mailboxes. information for only the specified target mailboxes.
The Exchange tracking log collection gathers both The mailbox contents collection (EWS) gathers only
message data and DLP rule matches. message data but includes specific data not found in
tracking logs such as
• file attachments
• “in reply to”
• time-of-day data.
The mailbox contents data collection can also include
message body text if configured.
NOTE: If a message is collected through EWS and the
message was sent from a mailbox user to a distribution
group to which the user belongs, the user is counted only
as a sender, not a recipient. If the tracking log collection
was also run, that user is also counted as a recipient.
The Exchange tracking log collection is much faster The mailbox contents collection is much slower than the
than the mailbox contents collection. Exchange tracking log collection.
You run the Exchange tracking log collection against The mailbox contents collection accesses the Exchange
both Exchange mailbox servers and hub transport CAS (Client Access Servers) to gather data.
servers.

For more detailed information, see What are the differences between the Exchange Mailbox Contents and
Exchange Tracking Logs data sources? on page 145.

Creating a data source for Exchange IIS

Logs
You configure an Exchange IIS logs data source to collect mobile device activities such as messages sent,
messages received, and device information from the IIS log files. You can also configure the Exchange IIS Logs
data source to collect Outlook on the Web (OWA) logon information.

Unified Communications Analytics 8.5 Deployment Guide

72
Adding data sources, chargeback costs, and thresholds for Exchange and Exchange Online
You must collect the logs of the IIS sites for both on your front-end Exchange Client Access Server (CAS) and on
your back-end Exchange Mailbox servers. The back-end IIS logs are required for information about the number of
messages that are downloaded and uploaded using ActiveSync.
• For information about what permissions are required by the credentials for the data collection, see
Permissions needed for the Exchange IIS logs (ActiveSync and OWA) data source on page 60.
• For information about how IIS logging must be configured on your Exchange CAS servers, see Appendix
C: Configuring IIS Log Files to capture ActiveSync or OWA events on page 121.
• For information about the ActiveSync events that are collected, see What ActiveSync events are collected
and displayed in the insights? on page 124.

To set up an Exchange IIS logs collection

1 Click the gear icon on the home page side bar.

2 Click Data Collection.
3 Click + beside the name of the target environment.
4 Select the Exchange IIS Logs check box.
5 Enable the data collection for this data source.
Data to Collect
6 Select the check box for each type of data to be collected:
▪ Exchange ActiveSync Events
▪ Logons for Outlook on the Web (OWA)
LDAP Connection Parameters
7 Specify the Windows credentials to be used for the LDAP connection to Active Directory or select the Use
Data Engine service credential option.
Targets
8 Select whether you want to collect data for all Exchange mailboxes or for only the mailboxes in specified
organizational units (OUs).
IIS Log Collection Parameters
9 Enter the path location for the IIS log files that you want to collect.
10 Enter the credentials needed to access the Exchange server that hosts the log files.
Advanced settings (not required for most deployments)
▪ To change the minimum interval between the data collection runs, click Show Advanced Settings
in the Scheduling section.
▪ If you want to specify one or more explicit domain controllers instead of automatically discovering
the domain controller, click Show Advanced Settings in the LDAP Collection Parameters section.
For more information, see Specifying explicit domain controllers for LDAP connections on page 38.
The domain controller must be a global catalog server.

NOTE: If the Data Engine is in a different forest from the data to be collected, you must
specify the domain controller you want to use for data collection.
If you leave the default setting to automatically discover domain controller, the data collector
selects a domain controller from the forest that hosts the Data Engine, not a domain controller
from the forest from which you are collecting the data.

11 Click Save.

Unified Communications Analytics 8.5 Deployment Guide

73
Adding data sources, chargeback costs, and thresholds for Exchange and Exchange Online
About the IIS log file locations
The Exchange ActiveSync IIS log files are located either in user-created file shares or in the IIS log directories of
your Exchange Client Access Servers (CAS) and Exchange Mailbox servers.
• If IIS is configured for one log file per server, the default path for the IIS log files is: \\servername\
c$\inetpub\logs\LogFiles\W3SVC.
• If IIS is configured for one log file per site, the default path for the IIS log files is: \\servername\
c$\inetpub\logs\LogFiles\W3SVCn where n is the site ID of the site.
For example, if the front-end site is site #1 and the back-end site is site #2 and both are on the same Exchange
server, the default paths will be as follows:
• \\servername\ c$\inetpub\logs\LogFiles\W3SVC1
• \\servername\ c$\inetpub\logs\LogFiles\W3SVC2

Creating a data source for Exchange

mailbox content summary
The Exchange mailbox content summary data collection gathers folder statistics from user mailboxes using
Exchange Web Services (EWS) and LDAP queries. You can also collect the dates for the last message sent and
last message read in a mailbox which is used in the Mailboxes - Inactive (Advanced) insight.
When you configure a mailbox content summary data collection, you must specify the target mailboxes and the
Client Access Server (CAS) URLs that are used to connect to the mailbox server. For Exchange 2016, you specify
the URL for the Client Access Services on the mailbox server.
When you specify target mailboxes, you can set all mailboxes, mailboxes for a specific mailbox server, mailboxes
that belong to a specific organizational unit (OU), or specific mailboxes as targets.

TIP: When specifying individual mailboxes as targets, it is recommended that you add the user mailboxes to
a distribution group. You can then add the distribution group for the target mailboxes.

The data source collection does not include system mailboxes. For a list of the types of mailboxes that are
excluded, see What types of mailboxes are excluded? on page 67.
If you have an Exchange hybrid environment, you can configure an Exchange Online Mailbox Content Summary
data source to collect Office 365 mailboxes. For more information, see Creating a data source for Exchange
Online mailbox content summary data source on page 84.

To set up a mailbox content summary data collection

1 Click the gear icon on the home page side bar.

2 Click Data Collection.
3 Click + beside the name of the target environment.
4 Select the Exchange Mailbox Content Summary check box.
5 Enable the data collection for this data source.
6 Specify the types of data to be collected.
▪ Mailbox Folders
▪ Message Statistics.
▪ Last Message Sent Date
▪ Last Message Read Date

Unified Communications Analytics 8.5 Deployment Guide

74
Adding data sources, chargeback costs, and thresholds for Exchange and Exchange Online
When specifying parameters to collect message statistics
7 If you select the option to collect Message Statistics, you can set a date range and collection scope:
a Enter the number of days back that message statistics should be collected. By default, 180 days is
set.
b Select whether you want to collect statistics for the entire mailbox or only the default folders (Sent
Items and Inbox).
Specifying the LDAP connection parameters
8 Specify the Windows credentials for the LDAP connection
- OR -
Select the Use Data Engine service credential option.
Specifying the target mailboxes
9 You have different options for specifying the target mailboxes to be included:
▪ Select all mailboxes.
▪ Specify the mailbox server for the mailboxes.
▪ Specify the organizational unit (OU) to which the mailboxes belong.
▪ Specify certain mailboxes that you want collected.
When specifying certain mailboxes you can enter the common name or email address of a mailbox,
a group. or a dynamic distribution group. For more information about using a dynamic distribution
group for target mailboxes, see Using dynamic distribution groups to select target mailboxes on
page 66.
Specifying data collection parameters for EWS connection
10 Select the versions of Exchange from which you want to collect data:
▪ Collect from mailboxes on all supported Exchange versions
▪ Specify a specific Exchange version from which you want to collect data.
11 Specify the credential used to collect the mailbox data. For more information see Permissions needed for
Exchange mailbox contents or Exchange mailbox content summary data sources on page 60.
12 Specify the URLs for the CAS (Client Access Servers or Client Access Services) to be used by Exchange
Web Services (EWS).
▪ Use Exchange auto-discovery for each mailbox
▪ Specify the specific Exchange Web Services URLs
TIP: In many Exchange environments, Exchange auto-discovery does not always work so it is
recommended that you specify individual Exchange Web Services URLs.

When you specify the CAS for the gathering, you must enter the URL for the server. For example,
the URL might be:
https://MyCASServer/ews/Exchange.asmx
You can specify multiple CAS URLs to be used for the EWS gathering. If you specify multiple CAS
URLs, data collection is faster. If you do not specify one or more CAS URLs, the Exchange
Autodiscover service is used to find the CAS servers for the target mailboxes.
Advanced settings (not required for most deployments)
▪ If you want to change the minimum interval between the data collection runs or change the Data
Engine (Collector) server to be used for the data source, click Show Advanced Settings in the
Scheduling section.
▪ If you want to specify one or more explicit domain controllers instead of automatically discovering
the domain controller, click Show Advanced Settings in the LDAP Collection Parameters section.
For more information, see Specifying explicit domain controllers for LDAP connections on page 38.

Unified Communications Analytics 8.5 Deployment Guide

75
Adding data sources, chargeback costs, and thresholds for Exchange and Exchange Online
 The domain controller must be a global catalog server.
If the Data Engine is in a different forest from the data to be collected, you must specify the domain
controller you want to use for data collection. If you leave the default setting to automatically
discover domain controller, the data collector selects a domain controller from the forest that hosts
the Data Engine, not a domain controller from the forest from which you are collecting the data.
13 Click Save.

Creating a data source for Exchange

public folders
By configuring an Exchange public folders data source, you can collect statistics for your legacy public folders
(Exchange 2010) and for your new public folders (Exchange 2013 and Exchange 2016). You can use the public
folder insights to track your migration from legacy to new public folders.
For information about what permissions are required by the credentials for the data collection, see Permissions
needed for the Exchange public folders data source on page 61.

To set up an Exchange public folders collection

1 Click the gear icon on the home page side bar.

2 Click Data Collection.
3 Click + beside the name of the target environment.
4 Select the Exchange Public Folders check box.
5 Enable the data collection for this data source.
6 Select the types of data that you want to collect.
7 Under Targets, select All Public Folders or enter the folder paths for specific public folders.
8 Specify the type of public folders that you are collecting.
▪ If you are collecting legacy public folders (Exchange 2010), click Legacy.
a If Exchange 2010 is the highest Exchange legacy version, enter the Exchange CAS server
and specify the credential to be used to create the remote PowerShell connection.
▪ If you are collecting public folders from Exchange 2013 or Exchange 2016, click New.
a Enter the Exchange CAS server and specify the credential to be used to create the remote
PowerShell connection.
Advanced settings (not required for most deployments)
▪ If you want to change the minimum interval between the data collection runs or change the Data
Engine (Collector) server to be used for the data source, click Show Advanced Settings in the
Scheduling section.
▪ To use HTTPS instead of HTTP to connect to the Exchange 2010/2013/2016 CAS server, click
Show Advanced Settings in the Credential section. This option requires that TLS/SSL is enabled
for remote PowerShell on the Exchange CAS server.
The Advanced Settings also provide options if you have a customized PowerShell virtual folder, or if
you want specify either an implicit credential or the Data Engine credential be used to make the
PowerShell connection.
9 Click Save.

Unified Communications Analytics 8.5 Deployment Guide

76
Adding data sources, chargeback costs, and thresholds for Exchange and Exchange Online
Adding Exchange Online hybrid data
sources for hybrid Office 365
If you have a hybrid Exchange Online (on-premise and Exchange Online) environment, there are four data
sources that you configure to collect from your hybrid Office 365 environment.
• Exchange Online Hybrid User Configurations which retrieves user and distribution group data using LDAP
and remote PowerShell. See Creating a data source for Exchange Online hybrid user configuration on
page 78.
• Exchange Online Hybrid Mailbox Configuration which retrieves Exchange Online mailbox configuration
including statistics, permissions and mobile devices. See Creating a data source for Exchange Online
hybrid mailbox configuration on page 79.
• Exchange Online Mailbox Contents which retrieves information about email traffic from Exchange Online
user mailboxes using Exchange Web Services (EWS). You can collect from some or all mailboxes. See
Creating a data source for Exchange Online mailbox contents data source on page 83.
• Exchange Online Mailbox Content Summary which retrieves statistics about mailbox folders from
Exchange Online user mailboxes using Exchange Web Services (EWS). See .Creating a data source for
Exchange Online mailbox content summary data source on page 84.

NOTE: The Exchange Online Mailbox Contents and the Exchange Online Mailbox Content Summary
data sources can be added to an Active Directory Forest / Office 365 (hybrid) target environment to
collect from hybrid Exchange Online or added to a native Office 365 target environment to collect
from native Exchange Online.

About AD synchronization methods for hybrid

Exchange Online
For hybrid Exchange Online environments, there are several different tools that are used to synchronize users and
mailboxes between on-premise Active Directory and Azure Active Directory.
When you configure the Exchange Online Hybrid User Configuration or the Exchange Online Hybrid Mailbox
Configuration data source, you must select the synchronization method that is deployed in your environment.
Essentially, all the different synchronization options use one of two methods to synchronize on-premise Active
Directory to Azure Active Directory.

Table 23. Hybrid synchronization methods for on-premise Active Directory and Azure Active Directory.

Synch Synchronization tool and

On-premise AD attribute Azure AD attribute
method environment
Method 1 Azure AD Connect msds-ExternalDirectoryObjectId ExternalDirectoryObjectId
(with Exchange 2016)
Method 2 Azure AD Connect ObjectGUID ImmutableId
(without Exchange 2016)
Azure AD Connect
(upgraded from DirSync)
Azure AD Sync (all environments)
DirSync (all environments)

Unified Communications Analytics 8.5 Deployment Guide

77
Adding data sources, chargeback costs, and thresholds for Exchange and Exchange Online
Do I need to add an Office 365 (native) target to collect
native objects in an Exchange hybrid environment?
My hybrid environment contains mailboxes and groups that were migrated from on-premise Exchange and
mailboxes and groups that were created directly in Office 365. Do I need to configure Office 365 native data
sources to collect native objects?

Answer
Only one target, an Active Directory Forest / Office 365 (hybrid) target, is needed for hybrid environments.
The hybrid Exchange Online data sources collect all hybrid objects, both the objects created on-premise and
migrated to Office 365 and the objects created in Office 365 (Office 365 native objects). For example, when
collecting groups, the Exchange Online Hybrid User Configuration data source collects both
• hybrid groups (created on-premise and migrated to Office 365)
• Office 365 native groups (created in Office 365).
If you were to add an Office 365 (native) target and run the Exchange Online native data source collections, the
hybrid objects would be duplicated.

Creating a data source for Exchange Online

hybrid user configuration
The Exchange Online Hybrid User Configuration data source gathers information about users and distribution
groups in a hybrid environment only.
By default, the data source collects only direct members of groups. For example, if a distribution group contained
10 users and 14 distribution groups, the number of direct members would be counted as 24.
If you want to collect the effective members (direct and indirect) for a group you can use the Advanced settings in
the Collect Effective (Direct and Indirect) Members for Groups section. For example, if you collect from a
distribution group that has 10 user members and one distribution group member (that has 20 members), the
number of direct members is 11 but the number of effective members is 30.

To set up an Exchange Online hybrid user configuration collection

1 Click the gear icon on the home page side bar.

2 Click Data Collection.
3 Click + beside the name of the target environment.
4 Select the Exchange Online Hybrid User Configuration check box.
5 Enable the data collection for this data source.
6 Select the types of data that you want to collect.
By default, the data source collection gathers direct members of standard distribution and security groups.
If you want to also collect direct members for dynamic distribution groups, select the Direct Members
check box under the selected Dynamic Distribution Groups check box.
7 Specify Windows credentials to be used for the LDAP connection or select the Use Data Engine service
credential option. See Permissions needed for the Exchange Online hybrid user configuration data source
on page 61.
8 Specify the Office 365 credential to be used to collect the user configuration data through remote
PowerShell.

Unified Communications Analytics 8.5 Deployment Guide

78
Adding data sources, chargeback costs, and thresholds for Exchange and Exchange Online
 To improve data collection performance you can provide multiple credentials.
TIP: Office 365 has a per-user throttling mechanism to protect the Exchange systems. It is
recommended that you use dedicated user accounts on this page to avoid throttling caused by
concurrent usage of the same account in other applications.

9 Select the tool that is used to synchronize your Azure Active Directory with on-premise Active Directory.
▪ Azure AD Connect with Exchange 2016
▪ Azure AD Connect
▪ Azure AD Sync
▪ DirSync

NOTE: If you use Azure AD Connect and have Exchange 2016 (mixed or native environment), select
Azure AD Connect with Exchange 2016 for optimal performance.

For information about synchronization methods, see About AD synchronization methods for hybrid
Exchange Online on page 77.
Advanced settings (not required for most deployments)
▪ If you want to change the minimum interval between the data collection runs or change the Data
Engine (Collector) server to be used for the data source, click Show Advanced Settings in the
Scheduling section.
▪ If you want to specify one or more explicit domain controllers instead of automatically discovering
the domain controller, click Show Advanced Settings in the LDAP Collection Parameters section.
For more information, see Specifying explicit domain controllers for LDAP connections on page 38.
The domain controller must be a global catalog server.

NOTE: If the Data Engine is in a different forest from the data to be collected, specify the
domain controller you want to use for data collection. If you leave the default setting to
automatically discover domain controller, the data collector selects a domain controller from
the forest that hosts the Data Engine, not a domain controller from the forest from which you
are collecting the data.

▪ By default, the data source collects direct members of groups. If you want to collect effective
members (direct and indirect) for groups, click Show Advanced Settings in the Collect Effective
(Direct and Indirect) Members for Groups section. You can select to collect effective members for
specified groups or for all groups.
If you select Effective members for specific groups and click Add group, you have the option to
add each group individually or you can enter a list of groups, each entry separated by a semi-colon
(;).

IMPORTANT: If you collect effective membership for many groups, it can have significant
impact on performance and storage requirements.

10 Click Save.

Creating a data source for Exchange Online

hybrid mailbox configuration
For a hybrid Office 365 environment, you can create a mailbox configuration collection to gather mailbox statistics
such as mailbox size, mailbox permissions, and remote devices from Exchange Online mailboxes. For a native
Office 365 environment, see Creating a data source for the Exchange Online native mailbox configuration data
source on page 82.
For more information about credential prerequisites, see Permissions needed for the Exchange Online hybrid
mailbox configuration data source on page 61.

Unified Communications Analytics 8.5 Deployment Guide

79
Adding data sources, chargeback costs, and thresholds for Exchange and Exchange Online
To set up an Exchange Online hybrid mailbox configuration collection

1 Click the gear icon on the home page side bar.

2 Click Data Collection.
3 Click + beside the name of the target environment.
4 Select the Exchange Online Hybrid Mailbox Configuration check box.
5 Enable the data collection for this data source.
6 Select the types of data to collect:
▪ Mailbox permissions
▪ Mailbox (permissions)
▪ Recipient permissions (Send As permissions)
▪ Delegates (Send On Behalf Of permissions)
▪ Mobile devices
▪ Mailbox statistics
▪ Personal Archive Mailboxes (Configuration)
▪ Personal Archive Mailboxes (Statistics)
7 Specify the target mailboxes you want to collect:
▪ All Exchange Online mailboxes
▪ Specific Exchange Online mailboxes
For specific mailboxes, you can enter the common name or email address of a mailbox, a group. or
a dynamic distribution group.
8 Specify the Windows credentials to be used for the LDAP connection or select the Use Data Engine
service credential option.
9 Specify the Office 365 credential to be used to collect the Exchange Online mailbox configuration data
through remote PowerShell.
To improve data collection performance you can provide multiple credentials.
TIP: Office 365 has a per-user throttling mechanism to protect the Exchange systems. It is
recommended that you use dedicated user accounts on this page to avoid throttling caused by
concurrent usage of the same account in other applications.

10 Select the tool that is used to synchronize your Azure Active Directory with on-premise Active Directory.
▪ Azure AD Connect with Exchange 2016
▪ Azure AD Connect
▪ Azure AD Sync
▪ DirSync

NOTE: If you use Azure AD Connect and have Exchange 2016 (mixed or native environment), select
Azure AD Connect with Exchange 2016 for optimal performance.

For information about synchronization methods, see About AD synchronization methods for hybrid
Exchange Online on page 77.
Advanced settings (not required for most deployments)
▪ If you want to change the minimum interval between the data collection runs or change the Data
Engine (Collector) server to be used for the data source, click Show Advanced Settings in the
Scheduling section.

Unified Communications Analytics 8.5 Deployment Guide

80
Adding data sources, chargeback costs, and thresholds for Exchange and Exchange Online
 ▪ If you want to specify one or more explicit domain controllers instead of automatically discovering
the domain controller, click Show Advanced Settings in the LDAP Collection Parameters section.
For more information, see Specifying explicit domain controllers for LDAP connections on page 38.
The domain controller must be a global catalog server.

NOTE: If the Data Engine is in a different forest from the data to be collected, you must
specify the domain controller you want to use for data collection. If you leave the default
setting to automatically discover domain controller, the data collector selects a domain
controller from the forest that hosts the Data Engine, not a domain controller from the forest
from which you are collecting the data.

11 Click Save.

Adding Exchange Online data sources

for native Office 365
If you have a native Office 365 environment, there are four data sources that you configure to collect from
Exchange Online using remote PowerShell and/or EWS:
• Exchange Online Native User Configurations which retrieves user and distribution group data using remote
PowerShell. See Creating a data source for Exchange Online native user configuration on page 81.
• Exchange Online Native Mailbox Configuration which retrieves Exchange Online mailbox configuration
including statistics, permissions and mobile devices. See Creating a data source for the Exchange Online
native mailbox configuration data source on page 82.
• Exchange Online Mailbox Contents which retrieves information about email traffic from Exchange Online
user mailboxes using Exchange Web Services (EWS). You can collect from some or all mailboxes. See
Creating a data source for Exchange Online mailbox content summary data source on page 84.
• Exchange Online Mailbox Content Summary which retrieves statistics about mailbox folders from
Exchange Online user mailboxes using Exchange Web Services (EWS). See Creating a data source for
Exchange Online mailbox content summary data source on page 84.

NOTE: Both the Exchange Online Mailbox Contents and the Exchange Online Mailbox Content
Summary data sources can be added to an Active Directory Forest / Office 365 (hybrid) target
environment to collect from hybrid Exchange Online or to a native Office 365 target environment to
collect from native Exchange Online.

Creating a data source for Exchange Online

native user configuration
For a native Office 365 target environment, you can create an Exchange Online native user configuration
collection to gather user and distribution group details from Exchange Online using remote PowerShell.
Exchange Online data sources do not display in the Data Collection page until you have added Office 365 as a
target environment. For more information, see Adding a target environment for native Office 365 on page 34.
For more information about credential prerequisites, see Permissions needed for Exchange Online native user
configuration data source on page 63.
By default, the data source collects only direct members of groups. For example, if a distribution group contained
10 users and 14 distribution groups, the number of direct members would be counted as 24.
If you want to collect the effective members (direct and indirect) for a group you can use the Advanced settings in
the Collect Effective (Direct and Indirect) Members for Groups section. For example, if you collect from a
distribution group that has 10 user members and one distribution group member (that has 20 members), the
number of direct members is 11 but the number of effective members is 30.

Unified Communications Analytics 8.5 Deployment Guide

81
Adding data sources, chargeback costs, and thresholds for Exchange and Exchange Online
To set up an Exchange Online native user configuration collection

1 Click the gear icon on the home page side bar.

2 Click Data Collection.
3 Click + beside the name of the Office 365 target environment.
4 Select the Exchange Online Native User Configuration check box.
5 Click the Exchange Online Native User Configuration tile to open the configuration page.
6 Enable the data collection for this data source.
7 Select the data that you want to collect.
By default, the data source collection gathers direct members of standard distribution and security groups.
If you want to also collect direct members for dynamic distribution groups, select the Direct Members
check box under the selected Dynamic Distribution Groups check box.
8 Specify the Office 365 credential used to collect the user configuration data through PowerShell.
Advanced settings (not required for most deployments)
▪ If you want to change the minimum interval between the data collection runs or change the Data
Engine (Collector) server to be used for the data source, click Show Advanced Settings in the
Scheduling section.
▪ By default, the data source collects direct members of groups. If you want to collect effective
members (direct and indirect) for groups, click Show Advanced Settings in the Collect Effective
(Direct and Indirect) Members for Groups section. You can select to collect effective members for
specified groups or for all groups.
If you select Effective members for specific groups and click Add group, you have the option to
add each group individually or you can enter a list of groups, each entry separated by a semi-colon
(;).

IMPORTANT: If you collect effective membership for many groups, it can have significant
impact on performance and storage requirements.

9 Click Save.

Creating a data source for the Exchange Online

native mailbox configuration data source
For a native Office 365 target environment, you can create a mailbox configuration collection to gather mailbox
statistics such as mailbox size, mailbox permissions, and remote devices from Exchange Online mailboxes using
remote PowerShell. For hybrid Office 365 (Exchange Online and on-premise Exchange), see Creating a data
source for Exchange IIS Logs on page 72.
Exchange Online data sources do not display in the Data Collection page unless you have added Office 365 as a
target environment. For more information, see Adding a target environment for native Office 365 on page 34.
For more information about credential prerequisites, see Permissions needed for Exchange Online native mailbox
configuration on page 63.

To set up an Exchange Online native mailbox configuration collection

1 Click the gear icon on the home page side bar.

2 Click Data Collection.
3 Click + beside the name of the Office 365 (native) target environment.
4 Select the Exchange Online Native Mailbox Configuration check box.

Unified Communications Analytics 8.5 Deployment Guide

82
Adding data sources, chargeback costs, and thresholds for Exchange and Exchange Online
 5 Click the Exchange Online Native Mailbox Configuration tile to open the configuration page.
6 Enable the data collection for this data source.
7 Select the types of data to collect:
▪ Mailbox permissions
▪ Mailbox (permissions)
▪ Recipient permissions (Send As permissions)
▪ Delegates (Send On Behalf Of permissions)
▪ Mobile devices
▪ Mailbox statistics
▪ Personal Archive Mailboxes (Configuration)
▪ Personal Archive Mailboxes (Statistics)
8 Specify the target mailboxes you want to collect:
▪ All Exchange Online mailboxes
▪ Specific Exchange Online mailboxes
For specific mailboxes, you can enter the common name or email address of a mailbox, a group. or
a dynamic distribution group.
9 Specify the Office 365 credential to be used to collect the mailbox configuration data through remote
PowerShell.

To improve data collection performance you can provide multiple credentials.

TIP: Office 365 has a per-user throttling mechanism to protect the Exchange systems. It is
recommended that you use dedicated user accounts on this page to avoid throttling caused by
concurrent usage of the same account in other applications.

Advanced settings (not required for most deployments)

▪ If you want to change the minimum interval between the data collection runs or change the Data
Engine (Collector) server to be used for the data source, click Show Advanced Settings in the
Scheduling section.
10 Click Save.

Creating a data source for Exchange Online

mailbox contents data source
For a native Office 365 or for an Active Directory/Office 365 hybrid target environment, you can create a mailbox
contents collection to gather email traffic from Exchange Online user mailboxes using Exchange Web Services
(EWS).
To improve data collection performance, you can provide multiple credentials when you configure the data source.
You can also create different mailbox contents data collections that contain different groups of users.
In addition to message traffic, you can configure the mailbox contents collection to gather the following message
information from the target mailboxes:
• Subject
• Body
• File attachments
• Localized send / receipt time of day (used to show “after hours” and “response time” data in insights)

Unified Communications Analytics 8.5 Deployment Guide

83
Adding data sources, chargeback costs, and thresholds for Exchange and Exchange Online
 • Internet Message Headers (provides technical details about the message, such as who sent it, the software
used to compose it, and the email servers that it passed through on its way to the recipient)
For more information about credential prerequisites, see Permissions needed for Exchange Online mailbox
contents data on page 62.

To set up an Exchange Online mailbox contents data collection

1 Click the gear icon on the home page side bar.

2 Click Data Collection.
3 Click + beside the name of an the Active Directory/Office 365 Hybrid or Office 365 (native) target
environment.
4 Select the Exchange Online Mailbox Contents check box.
5 Click the Exchange Online Mailbox Contents tile to open the configuration page.
6 Enable the data collection for this data source.
7 Select the data that you want to collect.
Recommendation
If you select Body or Internet Message Headers, it is recommended that you limit the number of mailboxes
to a key group of user mailboxes for this specific data collection.
8 Specify the Exchange Online target mailboxes. You can enter a mailbox, group, or a dynamic distribution
group in SMTP address format.
It is recommended that you add the Exchange Online users to a distribution group. You can then add the
distribution group for the target mailboxes.
9 Specify the Office 365 credential used to collect the mailbox data
To improve data collection performance you can provide multiple credentials.
TIP: Office 365 has a per-user throttling mechanism to protect the Exchange systems. It is
recommended that you use dedicated user accounts on this page to avoid throttling caused by
concurrent usage of the same account in other applications.

Advanced settings (not required for most deployments)

▪ If you want to change the minimum interval between the data collection runs or change the Data
Engine (Collector) server to be used for the data source, click Show Advanced Settings in the
Scheduling section.
10 Click Save.

Creating a data source for Exchange Online

mailbox content summary data source
For a native Office 365 or for an Active Directory/Office 365 hybrid target environment, you can create an
Exchange Online Mailbox Content Summary collection to gather folder statistics and/or last message sent
(received) details from Exchange Online user mailboxes using Exchange Web Services (EWS).
To improve data collection performance, you can provide multiple credentials when you configure the data source.
You can also create different mailbox contents data collections that contain different groups of users.
For more information about credential prerequisites, see Permissions needed for Exchange Online mailbox
content summary data on page 62.

To set up an Exchange Online Mailbox Content Summary data collection

1 Click the gear icon on the home page side bar.

Unified Communications Analytics 8.5 Deployment Guide

84
Adding data sources, chargeback costs, and thresholds for Exchange and Exchange Online
 2 Click Data Collection.
3 Click + beside the name of an the Active Directory/Office 365 Hybrid or Office 365 (native) target
environment.
4 Select the Exchange Online Mailbox Content Summary check box.
5 Click the Exchange Online Mailbox Content Summary tile to open the configuration page.
6 Enable the data collection for this data source.
7 Specify the types of data to be collected.
▪ Mailbox Folders
▪ Message Statistics.
▪ Last Message Sent Date
▪ Last Message Read Date
Specifying parameters to collect message statistics
8 If you have selected the option to collect Message Statistics, you can set a date range and collection
scope:
a Enter the number of days back that message statistics should be collected. By default, 180 days is
set.
b Select whether you want to collect statistics for the entire mailbox or only the default folders (Sent
Items and Inbox).
9 Specify the Exchange Online target mailboxes. You can enter a mailbox, group, or a dynamic distribution
group in SMTP address format.
It is recommended that you add the Exchange Online users to a distribution group. You can then add the
distribution group for the target mailboxes.
Setting the Exchange Web Service (EWS) connection credentials
10 Specify the Office 365 credential to be used to collect the mailbox folder statistics through EWS.
To improve data collection performance you can provide multiple credentials.
TIP: Office 365 has a per-user throttling mechanism to protect the Exchange systems. It is
recommended that you use dedicated user accounts on this page to avoid throttling caused by
concurrent usage of the same account in other applications.

11 Click Save.

Setting chargeback costs for Exchange

You can specify the costs at which your Exchange email is charged. The calculated values appear in specific
insights so you can determine the chargeback amounts for users or departments. You can use the chargeback
insights to compare with external and internal billing.
You can specify the unit on which costs are calculated such per instance or per MB.

To set chargeback costs for Exchange

1 On the Admin Settings page, click the Chargeback tile.
2 Specify the currency that should be used in the Currency Symbol field.
3 Under Exchange - Base Charges, you can set chargeback costs for email messages and for mailboxes.
a Click the Exchange row for which you want to assign a charge type and a cost.
b Select the charge type (instance or MB).

Unified Communications Analytics 8.5 Deployment Guide

85
Adding data sources, chargeback costs, and thresholds for Exchange and Exchange Online
 c Enter the cost to be changed for the charge type.
4 When you have completed entering charge types and costs to be calculated, click Save.

Setting thresholds for Exchange

metrics
You can set thresholds for Exchange metrics, using different colors to identify minimum and maximum values that
you want to track. When you view the metrics in an insight table, if a threshold is reached or exceeded, the value
shows the color that you specified. When you set a threshold, you set the color that displays when the number is
over or under a specified value.
By default, the Thresholds Classification page lists key Lync QoE thresholds that can be set. You can add
threshold classifications for Exchange ActiveSync, Exchange database, Exchange mailbox, Exchange message,
Exchange DLP, and Exchange public folder metrics.

To add a new threshold classification

1 Click Classifications and click Thresholds.
2 Click Add classification. For a list of Exchange fields for which you can set thresholds, see Table 24.

3 Beside the displayed field, click the down arrow and select the field that you want from the list.
4 Specify the operator for the threshold:
▪ greater than or equal to
▪ greater than
▪ less than or equal to
▪ less than
5 Set the value for the threshold and the units of measure.
6 Select the color (red, yellow, or green) that should display when the threshold is met.
7 To add another threshold for the metric, click Add threshold and specify the value, units of measure, and
color.

Unified Communications Analytics 8.5 Deployment Guide

86
Adding data sources, chargeback costs, and thresholds for Exchange and Exchange Online
Table 24. Exchange metric thresholds that can be added.

Type Threshold metric

Exchange ActiveSync Event • Elapsed Time
• Number of Email Attachments Downloaded
• Number of Email Attachments Uploaded
• Number of Email Attachments Transferred
• Number of Emails Downloaded
• Number of Emails Uploaded
• Number of Emails Transferred
• Response Code
• Sequence Number
• Size of Email Attachments Uploaded
• Size of Email Attachments Downloaded
• Size of Email Attachments Transferred
• Size of Emails Uploaded
• Size of Emails Downloaded
• Size of Emails Transferred
• Size of Items Uploaded
• Size of Items Downloaded
• Size of Items Transferred
Exchange Database • Available New Mailbox Space
• Deleted Item Retention Period
• Issue Warning Quota
• Log File Size
• Mailbox Retention Period
• Prohibit Send and Receive Quota
• Prohibit Send Quota
• Size
Exchange Database Copy • Copy Queue Length
• Replay Queue Length
Exchange DLP Match • Data Classification Confidence
• Data Classification Count
Exchange Email File Attachment • Size
Exchange Email Message • Size
Exchange Email Message Participant • Delivery Time
• First Response Time
Exchange Mailbox • Issue Warning Quota At
• Item Count
• Prohibit Send and Receive Quota At
• Prohibit Send Quota At
• Size
Exchange Legacy Public Folder • Age Limit
• Issue Warning Quota At
• Maximum Item Size
• Prohibit Post Quota At

Unified Communications Analytics 8.5 Deployment Guide

87
Adding data sources, chargeback costs, and thresholds for Exchange and Exchange Online
Table 24. Exchange metric thresholds that can be added.

Type Threshold metric

Exchange Legacy Public Folder Replica • Associated Items Count
• Associated Items Size
• Deleted Items Count
• Deleted Items Size
• Item Count
• Number of Contacts
• Number of Owners
• Size
Exchange Public Folders • Age Limit
• Associated Items Count
• Associated Items Size
• Deleted Item Retention Period
• Deleted Items Count
• Deleted Items Size
• Issue Warning Quota At
• Item Count
• Maximum Item Size
• Number of Contacts
• Number of Owners
• Prohibit Post Quota At
• Size

Omitting words when filtering by

subject or body
For insights that contain information about Exchange email messages, filters are available for Subject Keyword
and Body Keyword. The keyword filters list the words that occur most often in the subject or in the body of
messages.
Typically you do not want to include common words such as “the”, “of”, or “they”. To omit words from the subject or
body keywords, you add them to the Stop Words list.

To add words to be omitted from keyword filters

1 Click Queries and click Add Stop Words.
The entity is Email Message.
2 Click the down arrow and select the appropriate field:
▪ Subject Keywords
▪ Body Keywords
3 Enter any additional words that should be omitted when ranking keywords in messages.

Unified Communications Analytics 8.5 Deployment Guide

88
Adding data sources, chargeback costs, and thresholds for Exchange and Exchange Online
 6
Adding data sources, chargeback
costs, and thresholds for Skype for
Business/Lync
• Permissions needed to collect Skype for Business/Lync data
• Creating a data source for Skype for Business/Lync configuration
• Creating a data source for Skype for Business/Lync CDR
• Creating a data source for Skype for Business/Lync QoE
• Setting call classifications for Skype for Business/Lync
• Setting chargeback costs for Skype for Business/Lync
• Setting thresholds for Skype for Business/Lync metrics

Permissions needed to collect Skype

for Business/Lync data
To collect data from Skype for Business/Lync, you add different data sources to gather information. You can create
the following data sources:
• Skype for Business/Lync Configuration: collect Skype for Business/Lync server configuration and user
using PowerShell
• Skype for Business/Lync CDR Database: peer-to-peer session and conference details from a Skype for
Business/Lync CDR (Call Detail Recording) SQL database using SQL queries
• Skype for Business/Lync QoE Database: Quality of Experience (QoE) information from a Skype for
Business/Lync QoE SQL database using SQL queries
For each data source, you must specify the credential that is used to collect the data. In most collections, you have
the option to use the credential that is specified for the Data Engine service. If you want to use that credential for
your data collections, ensure it has the permissions specified for that data source.

Permissions needed for Skype for

Business/Lync configuration data source
The account you specify for a Skype for Business/Lync configuration data source is used to collect the user,
server, and pool configuration data from the Skype for Business/Lync servers. The account must have the
CsViewOnlyAdministrator RBAC (role-based access control) role in the Skype for Business/Lync organization.
The easiest method to assign this role is to add the user to the CS View-Only Administrators build-in security
group.

Unified Communications Analytics 8.5 Deployment Guide

89
Adding data sources, chargeback costs, and thresholds for Skype for Business/Lync
Permissions needed for Skype for
Business/Lync CDR data source
You create a Skype for Business/Lync CDR database data source to collect usage information about peer-to-peer
activities including instant messaging, Voice-over-Internet-Protocol (VoIP) calls, application sharing, file transfers,
and conferences from the CDR database.
The account that is used to collect the Skype for Business/Lync CDR data must have the following database role
membership in the CDR SQL databases:
• db_datareader
For UC Analytics to collect statistical conference and session data from Skype for Business/Lync server, the
Monitoring role must be installed on the Skype for Business/Lync server and Call Detail Recording (CDR) must be
enabled and running. For the steps to configure your Skype for Business/Lync server, see Appendix B: Configuring
the Skype for Business or Lync Server on page 117.

Permissions needed for Skype for

Business/Lync QoE data source
You create a Skype for Business/Lync QoE database data source to collect Quality of Experience (QoE) numeric
data that tracks the quality of audio and video calls in your organization. QoE must be enabled and running on the
Skype for Business/Lync server. For more information see Enable Quality of Experience on Lync Server 2013.
The account that is used to collect Skype for Business/Lync QoE data must have the following database role
membership on the QoE SQL database:
• db_datareader

Creating a data source for Skype for

Business/Lync configuration
The general workflow in adding data sources and setting up data collection is similar for each target environment
that you have create
When you configure a Skype for Business/Lync configuration data source, you specify the credential to be used to
connect to the Skype for Business/Lync server using remote PowerShell. You collect the server, service, user, and
pool configuration information directly from the Skype for Business/Lync server using remote PowerShell.
If you specify target users, the data collection will gather additional user configuration data such as:
• Effective user policies
• Audio/video enabled status
• Skype for Business/Lync user enabled status
• Public network enabled status

NOTE: If you want to enter specific target users (rather than select all users or an organizational unit), you
can enter a user, a group, or a dynamic distribution group. However, you cannot use the Domain Users
group. For more information see Can I enter the Domain Users group as the target for the data collection? on
page 67.
For more information about dynamic distribution groups, see Using dynamic distribution groups to select
target mailboxes on page 66.

Unified Communications Analytics 8.5 Deployment Guide

90
Adding data sources, chargeback costs, and thresholds for Skype for Business/Lync
To set up a Skype for Business/Lync configuration collection

1 Click the gear icon on the home page side bar.

2 Click Data Collection.
3 Click + beside the name of the target environment.
4 Select the Skype for Business/Lync Configuration check box.
5 Enable the data collection for this data source.
6 Select the types of data that you want to collect.
7 Specify the Windows credentials to be used for the LDAP connection or select the Use Data Engine
service credential option.
If you have an Skype for Business / Lync resource forest deployment
If you have a resource forest deployment, you must configure the options in the Account Forest LDAP
Connection Parameters section. This option is required only for Skype for Business / Lync resource
forests that have the active user accounts in a separate forest.
a Select the Search additional forests for user accounts for the linked Skype for Business /
Lync services check box.
The options under Show advanced settings are expanded.
b Select the appropriate option for the Account Forest Domain Controller:
▪ Automatically discover domain controller in specific domain
▪ Use specific domain controller
c Specify the credentials that are used to access the domain controller using LDAP.
8 Specify the target users for the data collection. You can select either:
▪ All Lync or Skype for Business enabled users in all domains.
▪ All Lync or Skype for Business enabled users in specified organizational units (OUs) or containers.
▪ Specific Lync or Skype for Business enabled users.
NOTE: For specific users, you can enter the common name or proxy address of the user or
group.

9 For the PowerShell connection, specify the Skype for Business/Lync front-end server from which you are
collecting data.
▪ Click Add server and enter the Skype for Business/Lync front-end server name (and port number if
applicable).
10 Specify the credentials to be used to connect through PowerShell.
The credential that is specified must have the appropriate permissions. For more information, see
Permissions needed for Skype for Business/Lync configuration data source on page 89.
Advanced settings (not required for most deployments)
▪ If you want to change the minimum interval between the data collection runs or change the Data
Engine (Collector) server to be used for the data source, click Show Advanced Settings in the
Scheduling section.
▪ If you want to specify one or more explicit domain controllers instead of automatically discovering
the domain controller, click Show Advanced Settings in the LDAP Collection Parameters section.
For more information, see Specifying explicit domain controllers for LDAP connections on page 38.
The domain controller must be a global catalog server.

Unified Communications Analytics 8.5 Deployment Guide

91
Adding data sources, chargeback costs, and thresholds for Skype for Business/Lync
 NOTE: If the Data Engine is in a different forest from the data to be collected, you must
specify the domain controller you want to use for data collection. If you leave the default
setting to automatically discover domain controller, the data collector selects a domain
controller from the forest that hosts the Data Engine, not a domain controller from the forest
from which you are collecting the data.

▪ To use HTTPS instead of HTTP to connect to the Skype for Business/Lync front-end server, click
Show Advanced Settings in the PowerShell Connection Parameters section. This option requires
that TLS/SSL be enabled for remote PowerShell on the Skype for Business/Lync front-end server.
The PowerShell Advanced Settings also provide options if you have a customized PowerShell
virtual folder, or if you want specify either an implicit credential or the Data Engine credential be
used to make the PowerShell connection.
11 Click Save.

Creating a data source for Skype for

Business/Lync CDR
You collect peer-to-peer session, enterprise voice, and conference data from the Skype for Business/Lync Call
Details Recording (CDR) database using a SQL query. You can collect session and conference information such
as:
• Start date and duration
• Participants
• Media types used
• Software clients
When you configure the Skype for Business/Lync CDR data source, you specify the CDR database and provide
the credential needed to access the database. The credential must have the appropriate permissions. For more
information, see Permissions needed for Skype for Business/Lync CDR data source on page 90.

To set up a Skype for Business/Lync CDR database collection

1 Click the gear icon on the home page side bar.

2 Click Data Collection.
3 Click + beside the name of the target environment.
4 Select the Skype for Business/Lync CDR Database check box.
5 Enable the data collection for this data source.
6 Select the types of data that you want to collect.
7 Specify the CDR SQL databases from which you want to gather data.
If you are not using the default port for SQL and must specify a custom port number, enter the SQL
database name (FQDN or host name) followed by a comma and the port number.

NOTE: You do not need to specify an instance when you enter an explicit port number. For example,
you would specify UCAServer1,2014 to connect to the instance on port 2014.

8 Specify how chargeback costs are calculated if enterprise voice calls go through both a PSTN gateway and
a Skype for Business/Lync mediation server by selecting either:
▪ PSTN gateway
▪ Skype for Business/Lync Mediation Server

Unified Communications Analytics 8.5 Deployment Guide

92
Adding data sources, chargeback costs, and thresholds for Skype for Business/Lync
 9 Enter a credential to be used to access the CDR database. You can select one of the following:
▪ Use the Data Engine service credential
▪ Specify a Windows credential
▪ Specify a SQL credential
Advanced settings (not required for most deployments)
▪ If you want to change the minimum interval between the data collection runs or change the Data
Engine (Collector) server to be used for the data source, click Show Advanced Settings in the
Scheduling section.
10 Click Save.

Creating a data source for Skype for

Business/Lync QoE
You collect Skype for Business/Lync Quality of Experience (QoE) data from the QoE database using a SQL query.
Quality data is available for peer-to-peer sessions, conferences, and enterprise voice calls.
When you configure the Skype for Business/Lync QoE data source, you specify the QoE database and provide the
credential needed to access the database. The credential must have the appropriate permissions. For more
information, see Permissions needed for Skype for Business/Lync QoE data source on page 90.

To set up an Skype for Business/Lync QoE database collection

1 Click the gear icon on the home page side bar.

2 Click Data Collection.
3 Click + beside the name of the target environment.
4 Select the Skype for Business/Lync QoE Database check box.
5 Enable the data collection for this data source.
6 Select the type of data that you want to collect.
7 Specify the QoE SQL databases from which you want to gather data.
If you are not using the default port for SQL and must specify a custom port number, enter the SQL
database name (FQDN or host name) followed by a comma and the port number.

NOTE: You do not need to specify an instance when you enter an explicit port number. For example,
you would specify UCAServer1,2014 to connect to the instance on port 2014.

8 Enter a credential to be used to access the QoE SQL database. You can select one of the following:
▪ Use the Data Engine service credential
▪ Specify a Windows credential
▪ Specify a SQL credential
Advanced settings (not required for most deployments)
▪ If you want to change the minimum interval between the data collection runs or change the Data
Engine (Collector) server to be used for the data source, click Show Advanced Settings in the
Scheduling section.
9 Click Save.

Unified Communications Analytics 8.5 Deployment Guide

93
Adding data sources, chargeback costs, and thresholds for Skype for Business/Lync
Setting call classifications for Skype for
Business/Lync
You can configure call classifications for your Skype for Business/Lync (such as local, long-distance, international,
toll-free, and so on). Later, when you enter chargeback costs, you select the call classifications to which costs are
assigned. For information about setting up chargeback costs, see Setting chargeback costs for Skype for
Business/Lync on page 94.
For Skype for Business/Lync calls, you can configure call classifications for enterprise voice calls. You can define
call classifications for outgoing calls, incoming calls, and internal peer-to-peer sessions.

About specifying Enterprise Voice call

classifications
When you define call classifications for Skype for Business/Lync Enterprise Voice outgoing and incoming calls,
you must specify the gateway or the mediation server that is being used for the call type. You can enter the FQDN
or IP address or server name. Typically you might enter the IP address for a gateway or the server name for a
mediation server.
TIP: If you encounter a problem trying to resolve the value that you entered for the mediation server or
gateway server, check an insight that contains the gateway and mediation server information, such as the
Skype for Business/Lync Peer-to-Peer Session Details insight. Enter the name or the IP address exactly as it
appears in the insight.

You also enter phone number (usually a destination mask) and number of digits for different call classifications. For
example, you can specify a phone number (or destination mask) for internal, local, toll-free and other types of
calls. You can use one wild card (“*”) in the destination mask to match the pattern for the normalized destination
phone numbers in Skype for Business/Lync.

To set classifications for Skype for Business/Lync incoming and outgoing calls
1 Click Classifications and click Call Classifications.
2 Click Add Classification for type of call that you want to define.
3 Enter a description for the call type.
4 Enter the mediation or gateway server name for the server used.
5 Enter the phone number associated with the call type. Since you can enter * wild cards, you usually would
enter a destination mask for a phone number. For example, you might specify 1800* for toll free calls.
6 Enter the number of digits for the call type. This field is optional. If the call type can be uniquely identified
through the phone number mask, you could leave this field empty.

Setting chargeback costs for Skype for

Business/Lync
You can specify chargeback costs for Skype for Business/Lync peer-to-peer sessions, conferences, and voice
calls. You can view the calculated values in the chargeback insights to determine the chargeback amounts for
users or departments. You can use the chargeback insights to compare with external and internal billing.
Essentially you can set two different types of charges:
• base charges for infrastructure costs

Unified Communications Analytics 8.5 Deployment Guide

94
Adding data sources, chargeback costs, and thresholds for Skype for Business/Lync
 • additional charges which include call minutes for each call classification
You can specify the unit on which peer-to-peer sessions and conferences costs are calculated such as per minute,
per MB, per person, or per instance.
For Skype for Business/Lync enterprise voice calls and peer-to-peer session calls, you can also create the call
classifications that are used to identify the different types of calls for chargeback. For more information about
specifying call classifications, see Setting call classifications for Skype for Business/Lync on page 94.

To set chargeback costs for Skype for Business/Lync

1 On the Admin Settings page, click the Chargeback tile.
2 Specify the currency that should be used in the Currency Symbol field.
3 Click a Skype for Business/Lync item or media type for which you want to assign a charge type and a cost.
4 Under Skype for Business/Lync - Base Charges, you specify the chargeback for each media type for both
peer-to-peer sessions and conferences.
a Click on the row for the media type you want.
b Select the charge type (per instance, per MB, per minute, per person, and so on).
c Enter the cost to be charged.
d Specify if rounding should be used to round the calculated cost up to the next minute (60 seconds)
or set the rounding value to whatever you want.
5 Under Skype for Business/Lync - Additional Charges, you can set specific chargeback costs for the call
classifications that you have defined (such as local, toll free, long distance, and so on).
a Specify the charge per minute for each call type.
b Specify if rounding should be used to round the calculated cost up to the next minute (60 seconds)
or set the rounding value to whatever you want.
6 When you have completed entering charge types and costs to be calculated, click Save.

Setting thresholds for Skype for

Business/Lync metrics
You can set thresholds for Skype for Business/Lync Quality of Experience (QoE) metrics, using different colors to
show good calls or the severity of poor calls. When you set a threshold, you set the color that displays when the
number is over or under a specified value. When you view a QoE insight, if a value shown in a table meets the set
threshold, a colored underline appears below the value.
By default, the Thresholds Classification page lists key Lync QoE thresholds that can be set. You can also add
thresholds for the conference and session metrics that are displayed in the Skype for Business/Lync insights. You
can use color to identify minimum and maximum values that you want to track.

To set thresholds for the default Skype for Business/Lync QoE metrics
1 Click Classifications and click Thresholds.
2 Click the metric for which you want to set a threshold.
By default, you can set or modify threshold levels for several key QoE stream quality metrics. For more
information, see About the default Skype for Business/Lync quality metrics on page 96.
3 Specify the operator for the threshold:
▪ greater than or equal to
▪ greater than

Unified Communications Analytics 8.5 Deployment Guide

95
Adding data sources, chargeback costs, and thresholds for Skype for Business/Lync
 ▪ less than or equal to
▪ less than
4 Set the value for the threshold and the units of measure.
5 Select the color (red, yellow, or green) that should display when the threshold is met.
6 To add another threshold, click Add threshold and specify the value, units of measure, and color.

About the default Skype for Business/Lync

quality metrics
The default metrics that display on the Thresholds Classifications page are preset with the recommended
thresholds for Skype for Business 2015 and for Lync 2013. Many of them also apply to Lync 2010. To add
recommended thresholds that apply only to Lync 2010, you can add a threshold classification for the specific
quality metric. For more information, see Adding new threshold classifications on page 98
The following table provides basic information about the quality metrics thresholds that are displayed by default:

Table 25. Default Skype for Business/Lync quality metrics and recommended thresholds.

Quality metric Description Possible thresholds

% of application The percentage of the content from the • > 36% is bad.
sharing content lost sharer that did not reach the viewer.
Content can be discarded (or spoiled)
when the sharer discards tiles from the
graphics source or when the ASMCU tiles
discards tiles from sharer respectively.
Available for Microsoft Lync Server 2013
and later only.
% of call with high Percentage of the call where the client • > 10% is bad
video CPU load experienced high CPU load when
processing video (dynamic capability flag
was active).
Available for Microsoft Lync Server 2013
and later only.
% of call with low video The percentage of the call that is below the • > 10% is bad
frame rate low frame rate threshold.
Available for Microsoft Lync Server 2013
and later only.
% of local video frames The percentage of the total video frames • > 10% is bad
lost that are lost.
Average % of packets Packet loss (%) represents the percentage • < 3% packet loss is considered
lost of packets that did not make it to their good
destination. • > 5% packet loss will affect audio
Packet loss will cause the audio to be • > 7% packet loss is poor (+7%
distorted or missing (on the receiver end). packet loss can be considered a
major degradation of quality)
• > 10% is extremely bad
• > 50% packet loss - essentially no
service
Average % of samples Average ratio of concealed samples • < 2% is good
concealed generated by audio healing to typical • > 3% is poor
samples.
• > 7% is bad

Unified Communications Analytics 8.5 Deployment Guide

96
Adding data sources, chargeback costs, and thresholds for Skype for Business/Lync
Table 25. Default Skype for Business/Lync quality metrics and recommended thresholds.

Quality metric Description Possible thresholds

Average % of video The packet loss rate after forward error • > 10% is bad
packets lost with error correction (FEC) has been applied.
correction Available for Microsoft Lync Server 2013
and later only.
Average application Average processing time for remote • > 400 msec is bad.
sharing RDP latency desktop protocol (RDP) tiles over the
duration of the viewing session. A higher
total equates to a longer delay in the
viewing experience.
Available for Microsoft Lync Server 2013
and later only.
Average jitter Jitter (ms) measures the variability of Generally, jitter metrics can be qualified as
packet delay and results in a distorted or follows:
choppy audio experience. • < 20 ms is good
Jitter can increase latency on networks. • > 30 ms is not good (but may be
acceptable)
• > 45 ms is poor
Average network MOS Network Average Mean Opinion Score • 5 – excellent
degradation (MOS) is the key measurement used to • 4 – good
gauge the perceived audio quality (based
• 3 – fair
on an algorithm that calculates how a
typical user would rate the voice quality). • 2 – poor
This metric shows the amount the Network • 1 – bad
MOS was reduced because of jitter and
packet loss.
It is an integer rating from 0 to 5.
Average relative Average amount of one-way latency • > 1.75 ms is bad.
endpoint latency between the two media end points involved
in the application sharing. This is a single-
hop latency measure. Relative one-way
latency measures the delay between the
client and the server.
Available for Microsoft Lync Server 2013
and later only.S
Average round trip Network Round Trip Time (RTT) is the For RTP packets as reported in the
latency most common measure of latency and is monitoring reports:
measured in ms. • < 200 ms is good
This measure is the average round trip • > 200 ms is poor
time for RTP packets between endpoints.
• > 500 ms is bad
When latency is high, users will likely hear
the words, but there will be delays.
Average video frame The average video frame rate sent • A value of < 7 frames per second is
rate (outbound) during the call and the average considered poor video quality.
video frame rate received (inbound) during
the call. (frames/s)
Average video frame Average frames per second received for all • A value of < 7 frames per second is
rate used video streams and computed over the considered poor video quality.
duration of the session. This metric is
reported for video streams when available.
(frames/s)

Unified Communications Analytics 8.5 Deployment Guide

97
Adding data sources, chargeback costs, and thresholds for Skype for Business/Lync
Adding new threshold classifications
In addition to the default threshold metrics, you can set thresholds for additional metrics. You can add threshold
classifications for more QoE metrics or for conference and peer-to-peer session metrics.

To add a new threshold classification

1 Click Classifications and click Thresholds.
2 Click Add classification.

3 Beside the displayed field, click the down arrow and select the field that you want from the list.
4 Specify the operator for the threshold:
▪ greater than or equal to
▪ greater than
▪ less than or equal to
▪ less than
5 Set the value for the threshold and the units of measure.
6 Select the color (red, yellow, or green) that should display when the threshold is met.
7 To add another threshold for the metric, click Add threshold and specify the value, units of measure, and
color.
You can add threshold classifications for the quality metrics that are specific only to Lync 2010.

Table 26. Lync 2010-only quality metrics and recommended thresholds.

Quality metric Description Possible thresholds

Average estimated The available bandwidth estimated on the • < 100 kbps is bad
bandwidth client-side. Absolute thresholds are not
useful, but when the client detects
bandwidth is low (< 100 kbps) audio quality
can easily be affected by other applications
or network congestion.
In Lync 2010 only.
Average Listen MOS The average predicted wideband listening • 5 excellent
MOS score for audio received from and • 4 good
sent to the network including speech level,
• 3 fair
noise level, codec, network conditions and
capture device characteristics. • 2 poor
Mean Opinion Score (MOS) is the gold • 1 bad
standard measurement to gauge the
perceived audio quality (an algorithm
calculates how a typical user would rate
the voice quality).
In Lync 2010 only.

In addition to adding the specific Lync 2010 recommended metric thresholds, you can add threshold classifications
for a wide range of numeric values that are reported in the Skype for Business/Lync insights.
The following table lists the additional thresholds that you can add and set.

Table 27. Skype for Business/Lync threshold classifications that can be added.

Type Threshold metric

QoE media session • Average Conversation MOS

Unified Communications Analytics 8.5 Deployment Guide

98
Adding data sources, chargeback costs, and thresholds for Skype for Business/Lync
Table 27. Skype for Business/Lync threshold classifications that can be added.

Type Threshold metric

QoE session • Device CPU Number of Cores
• Device CPU Processor Speed
QoE stream • % of Call at CIF Resolution
• % of Call at VGA Resolution
• % of Call Competing For Network Resources
• % of Call in Loss Congestion State
• % of Call in Loss Congestion State From Delayed Packets
• % of Call at HD720 Resolution
• % of Error Correction Packets Used
• % of Packets Dropped By Healer
• % of Video Frames Lost
• Average % of Samples Compressed
• Average % of Samples Stretched
• Average Application Sharing RDP Latency
• Average Echo
• Average Estimated Bandwidth
• Average Listen MOS
• Average Network MOS
• Average Network MOS Degradation From Jitter
• Average Network MOS Degradation From Packet Loss
• Average Video Bandwidth
• Average Video Bit Rate
• Maximum % of Packets Lost
• Maximum % of Samples Concealed
• Maximum Estimated Bandwidth
• Maximum Jitter
• Maximum Network MOS Degradation
• Maximum Round Trip Latency
• Maximum Video Bit Rate
• Minimum Estimated Bandwidth
• Minimum Listen MOS
• Minimum Network MOS
Conference participant • (Media session) Duration
• Number of IM Messages
Conference • Duration
Peer-to-peer session • Duration
• Response Code
Peer-to-peer session participant • Number of IM messages
Conferencing policy • Maximum Application Sharing Bit Rate
• Maximum Audio Bit Rate
• Maximum File Transfer Bit Rate
• Maximum Meeting Size
• Maximum Video Bit Rate

Unified Communications Analytics 8.5 Deployment Guide

99
Adding data sources, chargeback costs, and thresholds for Skype for Business/Lync
 7
Adding data sources, chargeback,
and thresholds for Cisco
• Permissions needed to collect Cisco data
• Creating a data source for Cisco configuration
• Creating a data source for Cisco CDR logs
• Setting call classifications for Cisco
• Setting chargeback costs for Cisco
• Setting thresholds for Cisco metrics

Permissions needed to collect Cisco

data
Cisco is supported only if Active Directory is present and Cisco end-users are synchronized to Active Directory
users using the SAM account name.
To collect data from Cisco, you add different data sources to gather information. You can create the following data
sources:
• Cisco Configuration: end-user data from the Cisco Unified Communications Manager (CUCM) and user
data from Active Directory using LDAP
• Cisco CDR Logs: Peer-to-peer session and conference details from the Cisco CDR (call detail records)
log files.
UC Analytics does not directly access your Cisco CDR database. You must copy the CDR logs to a share
location from which you want to gather the data. For example, you can configure the Cisco Unified
Communications Manager server to automatically upload the CDR logs to the directory you specify.

Permissions needed for the Cisco

configuration data source
You specify the credentials that are used to collect user data from Active Directory and the credentials used to
collect end-user data from the Cisco Unified Communications Manager (CUCM) server.
• The credential that is used to collect Active Directory (LDAP) user data must have read permissions on all
the Active Directory user, group and contact objects.
• The credential that is used to collect Cisco end-user data (including phone number and SAM account) must
have read permissions on the Cisco Unified Communications Manager server. The credential must be a
member of user group Standard AXL API Access.
There are different methods that Active Directory (LDAP) can be integrated with Cisco. UC Analytics requires that
the SAM account name be used to synchronize the Cisco end-users and Active Directory users.

Unified Communications Analytics 8.5 Deployment Guide

100
Adding data sources, chargeback, and thresholds for Cisco
Permissions needed for the Cisco CDR logs
data source
To configure the Cisco CDR logs data source, you require the following credentials and permissions:
• You must specify a credential to access the Cisco server to collect Cisco configuration for the specified
Cisco Unified Communications Manager (CUCM). The credential must be a member of user group
Standard AXL API Access.
• To access the directories that contain the CDR logs, you can enter specific Windows credentials or you can
use the credential that is specified for the Data Engine service. The credential used to access the Cisco
CDR logs must have read rights on all the file shares on which you have stored the log files.

Creating a data source for Cisco

configuration
By creating a Cisco configuration data collection, you can collect Cisco end-user information including Cisco
phone numbers, device IDs, and the user information from Active Directory (LDAP).
For information about prerequisites, see Permissions needed for the Cisco configuration data source on page 100.

To set up a Cisco configuration collection

1 Click the gear icon on the home page side bar.

2 Click Data Collection.
3 Click + beside the name of the target environment.
4 Select the Cisco Configuration check box.
5 Enable the data collection for this data source.
6 Select the types of data that you want to collect.
7 Specify the Windows credentials to be used for the LDAP connection to Active Directory or select the Use
Data Engine service credential option.
8 Specify the Cisco Unified Communications Manager (Call Manager) server and credentials to collect Cisco
data.
Advanced settings (not required for most deployments)
▪ If you want to change the minimum interval between the data collection runs or change the Data
Engine (Collector) server to be used for the data source, click Show Advanced Settings in the
Scheduling section.
▪ If you want to specify one or more explicit domain controllers instead of automatically discovering
the domain controller, click Show Advanced Settings in the LDAP Collection Parameters section.
For more information, see Specifying explicit domain controllers for LDAP connections on page 38.
The domain controller must be a global catalog server.

NOTE: If the Data Engine is in a different forest from the data to be collected, you must
specify the domain controller you want to use for data collection. If you leave the default
setting to automatically discover domain controller, the data collector selects a domain
controller from the forest that hosts the Data Engine, not a domain controller from the forest
from which you are collecting the data.

9 Click Save.

Unified Communications Analytics 8.5 Deployment Guide

101
Adding data sources, chargeback, and thresholds for Cisco
Creating a data source for Cisco CDR
logs
By creating a Cisco CDR log collection, you can gather data about Cisco voice-over-IP and other peer-to-peer
sessions, ad hoc conferences, and MeetMe Conferences.
You gather the Cisco CDR (call detail recording) logs from one or more specified file shares. Typically, you set up
a process to copy the log files from your Cisco server to a specified directory. For example, you could configure the
Cisco Unified Communications Manager server to automatically upload the CDR logs to a directory you specify.
To configure a Cisco CDR log data collection, you must specify the following:
• the Cisco Unified Communications Manager (CUCM) server used to collect the Cisco configuration and the
associated credential
• the locations of the CDR log file shares from which you want to gather data
• the credentials used to access the CDR logs
For information about prerequisites, see Permissions needed for the Cisco CDR logs data source on page 101.

To set up a Cisco CDR log collection

1 Click the gear icon on the home page side bar.

2 Click Data Collection.
3 Click + beside the name of the target environment.
4 Select the Cisco CDR Logs check box.
5 Enable the data collection for this data source.
6 Select the types of data that you want to collect.
7 Specify the Cisco Unified Communications Manager (CUCM) server to which you want to connect and the
port to be used.
8 Specify the Cisco credential to access the CUCM.
9 Specify each folder location of the directories from which the Cisco CDR logs are to be gathered.
10 Specify the credentials that are used to gather the CDR logs.
Advanced settings (not required for most deployments)
▪ If you want to change the minimum interval between the data collection runs or change the Data
Engine (Collector) server to be used for the data source, click Show Advanced Settings in the
Scheduling section.
11 Click Save.

Setting call classifications for Cisco

You can configure call classifications for your Cisco calls (such as local, long-distance, international, toll-free, and
so on). When you set up chargeback costs, you can select the call classifications to which costs are assigned. For
information about setting up chargeback costs, see Setting chargeback costs for Cisco on page 103.
For Cisco calls, you can define call classifications for outgoing peer-to-peer sessions, incoming peer-to-peer
sessions, and internal peer-to-peer sessions.

Unified Communications Analytics 8.5 Deployment Guide

102
Adding data sources, chargeback, and thresholds for Cisco
About specifying Cisco call classifications
When you define call classifications for Cisco outgoing and incoming calls, you must specify the endpoint that is
being used for the call type. The endpoint is the port that is used by the call on the Cisco gateway. Gateways can
have multiple endpoints dependent on the number of ports that each gateway contains.
You also enter phone number (usually a destination mask) and number of digits for different call classifications. For
example, you can specify a phone number (or destination mask) for internal, local, toll-free and other types of
calls. You can use one wild card (“*”) in the destination mask to match the pattern for the phone numbers in Cisco.

To set classifications for incoming and outgoing Cisco calls

1 Click Classifications and click Call Classifications.
2 Click Add Classification for type of call that you want to define.
3 Enter a description for the call type.
4 Enter the endpoint name for the Cisco endpoint used.
5 Enter the phone number associated with the call type. Since you can enter * wild cards, you usually would
enter a destination mask for a phone number. For example, you might specify 1800* for toll free calls.
6 Enter the number of digits that are required for the targeted call. This field is optional. If the call type can be
uniquely identified through the phone number mask, you could leave this field empty.
For example, a Toll Free 800 number is 11 digits so you could enter 11 digits for the Toll Free entry.
For both Lync and Cisco internal peer-to-peer sessions, you specify phone number information and the number of
digits for both the caller and the callee.

Setting chargeback costs for Cisco

You can specify the costs at which your Cisco peer-to-peer calls and conference calls are charged. You can view
the calculated values in the chargeback insights to determine the chargeback amounts for users or departments.
You can use the chargeback insights to compare with external and internal billing.
For Cisco voice calls and peer-to-peer sessions, you can also create the call classifications that are used to
identify the different types of calls for chargeback. For more information about specifying call classifications, see
Setting call classifications for Cisco on page 102.

To set chargeback costs for Cisco

1 On the Admin Settings page, click the Chargeback tile.
2 Specify the currency that should be used in the Currency Symbol field.
3 Click a Cisco item or media type for which you want to assign a charge type and a cost.
4 Under Cisco - Base Charges, you specify the chargeback for each media type for both peer-to-peer
sessions and conferences.
a Click on the row for the media type you want.
b Select the charge type (per instance, per MB, per minute, per person, and so on).
c Enter the cost to be charged.
d Specify if rounding should be used to round the calculated cost up to the next minute (60 seconds)
or set the rounding value to whatever you want.
5 Under Cisco - Additional Charges, you can set specific chargeback costs for the call classifications that you
have defined (such as local, toll free, long distance, and so on).
a Specify the charge per minute for each call type.

Unified Communications Analytics 8.5 Deployment Guide

103
Adding data sources, chargeback, and thresholds for Cisco
 b Specify if rounding should be used to round the calculated cost up to the next minute (60 seconds)
or set the rounding value to whatever you want.
6 When you have completed entering charge types and costs to be calculated, click Save.

Setting thresholds for Cisco metrics

You can set thresholds for Cisco metrics, using different colors to identify minimum and maximum values that you
want to track. When you set a threshold, you set the color that displays when the number is over or under a
specified value. When you a viewing the metrics in an insight table, if the threshold value is reached, the metric
displays in the color you specified.
By default, the Thresholds Classification page lists key Lync QoE thresholds that can be set. You can set
thresholds for the following Cisco session and conference metrics:
• Cisco Peer-to-Peer Session - Duration
• Cisco Conference - Duration
• Cisco Conference Session - Duration

To add a new threshold classification

1 Click Classifications and click Thresholds.
2 Click Add classification.

3 Beside the displayed field, click the down arrow and select the field that you want from the list.
4 Specify the operator for the threshold:
▪ greater than or equal to
▪ greater than
▪ less than or equal to
▪ less than
5 Set the value for the threshold and the units of measure.
6 Select the color (red, yellow, or green) that should display when the threshold is met.
7 To add another threshold for the metric, click Add threshold and specify the value, units of measure, and
color.

Unified Communications Analytics 8.5 Deployment Guide

104
Adding data sources, chargeback, and thresholds for Cisco
 8
Managing which insights can seen
by users
• Enabling a Company Home Page
• Setting insight visibility settings

Enabling a Company Home Page

Users can create and populate their own home pages that only they can see. As a product administrator, you can
enable a Company Home Page and populate it with customized insights that can be viewed by all UC Analytics
users.
If, at a later date, you want to remove the Company Home Page, you can disable it and the icon no longer appears
for users to select.
This option is different than granting data access for users. For information about setting data access for users,
see Granting users access to data on page 45.

To enable a Company home page

1 Click the gear icon on the home page side bar.

2 Click Company Home Page.
3 Select the Enable Company Home Page section check box.
4 Click Save.

Now when you access the UC Analytics web page, the Company home page icon displays on the left.
As a product administrator, you can populate the Company home page with insights from the library, load a set of
recommended insights, or import insights from a file.
For more information about adding insights to a home page and customizing insights, see the Unified
Communications Analytics User Guide.

Setting insight visibility settings

You can use the insight visibility options to hide certain insights from all or some users, or to allow only certain
users to view some insights. You can add rules to hide or show insights for all users in all target environments, or
for specific users (or groups of users) in a specific target environment,

Unified Communications Analytics 8.5 Deployment Guide

105
Managing which insights can seen by users
How is insight visibility different from data
access?
Setting insight visibility is different than setting the data access for users. If a user does not have sufficient access
to the data in an insight, the insight appears in the library but is greyed out. If an insight is hidden from a user
through an insight visibility rule, the insight does not appear in the library for that user at all. For information about
setting data access for users, see Granting users access to data on page 45.
For example, if Cisco is not used in your environment, you might decide to hide all the Cisco insights from all
users.

Creating an insight visibility rule for insights

1 Click the gear icon on the home page side bar.

2 Click Insight Visibility.
3 Click Add visibility rule.
In the Add Visibility Rule wizard, you can scroll down through all the insights or you can select an insight
type heading, such as CISCO, and scroll through that type of insight.
4 Select the insights to which the rule is to be applied.
For example, you could click the CISCO heading and Select All to select all the Cisco insights.
5 Select the visibility action for the selected insights:
▪ Hide insights
▪ Only show insights.
For example, to hide all the selected Cisco insights, you would click Hide insights.
6 Select the users affected by the visibility rule. You can specify all users in all target environments or select
specific users or distribution groups in specific target environments.
For example, to hide all Cisco insights from all users, you would select the Apply rule to all users in all
target environments check box.
7 Click Add.
The Visibility settings page shows the rule that you have created. It lists the action (hide or show), the
insights that were selected, and the users that are affected by the rule.
8 Click Save.
You can modify a visibility rule by selecting the rule in the Visibility Settings list, making the changes that you want,
and clicking Save.

Unified Communications Analytics 8.5 Deployment Guide

106
Managing which insights can seen by users
 9
Configuring and managing
subscriptions
• What are insight subscriptions?
• Configuring settings for subscriptions
• Managing user subscriptions

What are insight subscriptions?

In addition to viewing insights on the Analytics web site, users can create subscriptions for insights. Subscriptions
allow users to automatically export selected insights to a format such as PDF, Microsoft Word (.docx), HTML,
MHTML, or to csv (raw or localized), or tsv (raw or localized) formats.
Each subscription is scheduled to automatically send the exported insight to specific email addresses or to a file
share, such as a SharePoint folder.
NOTE: For information about the difference between raw and localized .csv file format, see the section titled
“Can I export an insight?” in the Unified Communications Analytics User Guide.

Users can create different schedules for each subscription so that the subscription insights are exported and sent
on a regular basis.

Configuring settings for subscriptions

Before users can create and send subscriptions, you, as a UC Analytics administrator, must specify the SMTP
relay server that is used to email the subscriptions. (If you are configuring subscriptions to post to file shares only,
you do not have to specify a SMTP relay server.)
If you want, you can also specify a custom From Address and display name that appears on the subscription
emails as the sender.

Prerequisites
You must be a product administrator to access Admin Settings.
Optionally, you can require authentication be used to access the SMTP server for email subscriptions. If you
enabled authentication by checking the Authentication check box, the authentication credentials must have Sent
As permissions for the Active Directory user associated with the email address that is in the Sender Address field.
The Sender Email Address is used to send SMTP email subscriptions and the Sender Display Name appears in
the From field in the email.

Unified Communications Analytics 8.5 Deployment Guide

107
Configuring and managing subscriptions
 NOTE: The Sender Display Name that you specify may not always be shown in the From field when a
recipient views a subscription email in Outlook or through OWA. In some case, the recipient will see the user
name from the matching user object in Active Directory. This is due to changes made in Exchange 2010 and
later that affect how the From header is populated.

To specify configuration settings for all subscriptions

1 Click the gear icon on the home page side bar to access Admin Settings.
2 Click the Subscriptions tile.
General Settings
3 Ensure that Enable subscriptions is selected.
a For subscriptions where exported insights are sent by email, ensure that Enable email as a target
output is selected.
b For subscriptions where exported insights are posted to a file share, ensure that Enable file share
as a target output is selected.
4 Select a value for Parallel subscriptions threshold to limit the number of subscriptions that can run
concurrently.
NOTE: Threshold value should not be more than two times the number of processor cores on the UC
Analytics server that runs the Insights role.

Email SMTP Settings

5 Enter the SMTP mail server to be used to send subscription emails.
a If required, specify a port for the SMTP server in the Port: field.
NOTE: Since not all SMTP communication is done over port 25, you can specify the port
number for the SMTP server. When the server name is displayed, the port number appears
after a colon (:) at the end of the server name.

6 Specify an email address that will used as the email subscription sender address as in the Sender Email
Address field.
If you enable SMTP authentication (described in the Advanced settings section that follows), the
authentication credentials that you specify must have Sent As permissions for this sender address.
7 Optionally, you can specify a recipient for a test message in the Test Subscription Recipient field.
You can test that email subscriptions can be successfully sent by specifying a valid email address as the
Test Subscription Recipient. After you enter the email address, click the Send Test Subscription button to
send a test email to the specified address.
If you require authentication to access the SMTP server and want specify SMTP encryption, click Show
advanced settings.
Advanced settings (not required for most deployments)
8 If authentication is required, select Use authentication for SMTP server and click Set credential.
a Enter the credentials that are to be used to access the SMTP server.
a If TLS or SSL is required to connect to the SMTP server, select the down arrow beneath the SMTP
Encryption heading and select one of the following:
▪ Use SSL
▪ Use TLS
9 Enter the display name that should show as the From name on email subscriptions in the Sender Display
Name field.

Unified Communications Analytics 8.5 Deployment Guide

108
Configuring and managing subscriptions
 Subscription Retry Settings
10 If you want a subscription to attempt a retry when there is a failure, select Retry on subscription failure
and select the number retries that should be attempted.

NOTE: If you set Retry on subscription failure, UC Analytics will attempt to send the subscription
every 30 minutes until the specified number of retries has been attempted.

11 Select the type of error that would trigger a failed subscription run to retry:
▪ Unable to write to the file share - access is denied
▪ Not enough disk space available in file share location
▪ Recipient mailbox is unavailable
▪ Unable to connect to the SMTP server
▪ Sending email failed by timeout
▪ Subscription sending was terminated due to server fault
For example, you might want the subscription to retry delivery if there is a transient error that causes the
SMTP server to be unavailable. In this case, you could select the Unable to connect to SMTP server and
leave the other options clear.
12 Click Save.
Once you have configured the Admin Settings for subscriptions, users can create subscriptions for insights. For
information about how to create and schedule subscriptions, see the UC Analytics User Guide.

What if I configure authenticated SMTP with an Exchange

server that uses Integrated Windows authentication?
Suppose you are configuring subscriptions to use authenticated SMTP and the following conditions apply:
• The SMTP server is an Exchange server.
• The Exchange server is configured to authenticate SMTP connections with Integrated Windows
authentication.
In this case, the specified credential must be from a domain that is trusted by the domain which contains the server
hosting UC Analytics. Integrated Windows authentication will likely use Kerberos authentication. Windows will not
allow UC Analytics to construct the required Kerberos token if the token is from a domain that the server does not
trust.
As in all other cases of authenticated SMTP through an Exchange server, the credential must have SendAs
permission on the Active Directory user to which the Sender Address belongs (if the address is not one of the
credential’s own email addresses).

Managing user subscriptions

As a product administrator, you have the ability to manage subscriptions that are created by other users. For
example, several subscriptions might have been created by a user who is no longer with the company. You can
access these subscriptions and disable or delete them if you want.
You can also create subscriptions for existing users that run under that user’s credentials.

To manage subscriptions

1 On the UC Analytics web site home page, click the subscriptions icon on the left border.
The list of your own subscriptions is displayed.

Unified Communications Analytics 8.5 Deployment Guide

109
Configuring and managing subscriptions
2 Click the Manage subscriptions for other users link on the top right.
A list of users is displayed.
3 Select the name of the user that owns the subscriptions that you want to modify or delete.
A list of the subscriptions owned by that user is displayed.
4 At the top of the list, you can select an option the will affect all of the subscriptions or create a new
subscription for that user.

Table 28. General options for managing user subscriptions,

Option Meaning
Create a new subscription for the selected user.

Refresh the list of subscriptions.

Delete all the user subscriptions.

Rerun all subscriptions that previously failed.

5 If you want to delete or modify a single subscription, select the subscription that you want.
You can modify a subscription, view the launch history for a subscription, or delete the subscription:

a To modify the subscription, click on the subscription to open the subscription wizard which allows
you to change the following parameters:
▪ the schedule
▪ the insights included in the subscription
▪ the delivery format
▪ the recipients of the subscription

NOTE: For detailed information about creating subscriptions, see the Unified
Communications Analytics User Guide.

b To view the subscription launch history, click . For a description about the information that is
shown in the subscription launch history, see the Unified Communications Analytics User Guide.

c To run the subscription now, regardless of schedule, click .

d To delete the subscription, click .

Unified Communications Analytics 8.5 Deployment Guide

110
Configuring and managing subscriptions
 10
Making changes to your deployment
• Options available in the Deployment Manager
• Deploying additional Storage Engines
• Deploying additional collectors
• Using the Tools menu for support activities

Options available in the Deployment

Manager
After you have installed UC Analytics, you can make changes to your deployment. Typically you use the UC
Analytics.exe file to access the following options that can be used to manage your installation:

Table 29. Options available for managing the UC Analytics installation.

Option Name Function

Uninstall All Allows you remove all the installed services.
Manage Deployment Allows you to update the properties for the installed services, add additional
Storage Engines, and to add or remove product administrators.
Manage Licenses Shows a list of the installed licenses if you are running the
DeploymentManager.exe on the server on which Data Engine service is
installed.
Though you can see only the licenses installed on this Data Engine server, if
you add a new license, the new license is automatically installed on all your
Data Engine servers if you have a multiple Data Engine deployment.
Tools Allows you to set detailed logging and to create a support bundle that can be
used by Quest Support to troubleshoot any issues.
In some circumstances the TLS/SSL certificates for the Storage Engine and
the Query Engine might become corrupted such as when the Storage Engine
and Query Engine folders are not excluded from your antivirus scans. In this
situation, you can use the Tools option to regenerate the certificates.

To make changes in your deployment

1 Start the installer by double-clicking the UC Analytics.exe file.
- OR -
From the Start menu, select Programs | Quest UC Analytics | UC Analytics.
2 Click Manage Deployment.
3 Select the option that you want:

Unified Communications Analytics 8.5 Deployment Guide

111
Making changes to your deployment
 Table 30. Options available for managing the UC Analytics deployment.

Option Name Function

Change Product Allows you to add users who have access to the Admin Settings. Product
Administrators administrators can classify domains for message reporting, set user access for
insights, and perform other administrative functions.
Enter accounts in the format of Domain\User or ComputerName\User only.
Accounts in user principal name (UPN) format (such as [email protected])
are not supported.
NOTE: You can also add product administrators through Admin Settings on the
UC Analytics web site. Select Admin Settings | Security. Under Access to
Tenant Configuration heading, add the user to Admin Settings with full access.
For details, see Granting full access to Admin Settings on page 45.
Modify Deployment Allows you to move or update the properties for the installed services. You can
also add more Storage Engines.

Deploying additional Storage Engines

When you install UC Analytics, you specify the locations on which the different services are to be installed. You
can install multiple instances of the Storage Engine service.
At a later date, you might want to add more Storage Engines to distribute the collected data.

NOTE: If you must reboot the computer on which the Storage Engine service is installed and you have a
larger database, there can be a period of 5 to 10 minutes before UC Analytics will be available.

To add more Storage Engines

1 Start the installer by double-clicking the UC Analytics.exe file.
- OR -
From the Start menu, select Programs | Quest UC Analytics | UC Analytics.
2 Click Modify Deployment.
3 Click Add Server and select the Storage Engine role.
4 Specify the server on which the Storage Engine service will be installed.
5 To change the default values for a server role, click Edit Properties.
6 Click Advanced, enter any changes to the properties for the selected server role and click OK.

Table 31. Storage Engine service properties.

Physical Memory (MB) Ensure the check box is selected to calculate whether sufficient
Calculate automatically memory is available. If you clear the check box, the value you enter in
text box is assigned.
NOTE: Physical memory is automatically assigned during installation.
After you successfully install, if you display the properties dialog, the
currently installed physical memory is displayed in the text box.
Query Port Number If the port is already used by another application, change the port
number. This port is used by the Query Engine service to access the
Storage Engine service.

7 In the Storage Directory Path field, specify the directory path in which all the collected data is to be stored.
When you install additional Storage Engines, it can take several minutes to start and synchronize all the Storage
Engine services before they are ready.

Unified Communications Analytics 8.5 Deployment Guide

112
Making changes to your deployment
Deploying additional collectors
When you install UC Analytics, you specify the locations on which the different services are to be installed. Initially
you might only install the Data Engine (Collector) and Query Engine (Collector) on one server even though you
can install the collector roles on multiple servers.
At a later date, once you have been running the data source collections for a while, you might want to add more
collector roles to distribute the data collection and data writing load.

TIP: When you view an existing deployment in the Configure Deployment page, you can identify the Data
Engine (Collector) that is used as the Primary Data Collector since it is identified up arrow icon instead of
a check mark.

To add a Data Engine (Collector) and Query Engine (Collector)

1 Start the installer by double-clicking the UC Analytics.exe file.
- OR -
From the Start menu, select Programs | Quest UC Analytics | UC Analytics.
2 Click Modify Deployment.
3 Click Add Server and select the Data Engine (Collector) and/or the Query Engine (Collector).
4 Specify the server on which the Data Engine (Collector) and/or Query Engine (Collector) will be installed.
5 To change the default values for the server role, click Edit Properties.
6 Click Advanced, enter any changes to the properties for the selected server role and click OK.

Table 32. Data Engine service properties.

Query Port Number If the port is already used by another application, change the port
number. This port is used by the web site to access the Data Engine
service for query purposes.
Configuration Port Number If the port is already used by another application, change the port
number. This port is used by the web site to access the Data Engine
for configuration purposes.
Primary Data Collector When installing the Data Engine (Collector), you can specify that the
collector be used as the Primary Data Collector which is used to run
any background jobs such as Database Consistency. For information
about these jobs, see Data sources that run in background as needed
on page 40.
By default, the first installed Data Engine (Collector) is set to be the
Primary Data Collector.

Table 33. Query Engine service properties.

Physical Memory (MB) Ensure the check box is selected to calculate whether sufficient
Calculate automatically memory is available. If you clear the check box, the value you enter in
text box is assigned.
NOTE: Physical memory is automatically assigned during installation.
After you successfully install, if you display the properties dialog, the
currently installed physical memory is displayed in the text box.
Query Port Number If the port is already used by another application, change the port
number. This port is used by the Data Engine service to access the
Query Engine service.

Unified Communications Analytics 8.5 Deployment Guide

113
Making changes to your deployment
Using the Tools menu for support
activities
If you have opened a case with Quest Support, you may be requested to enable detailed logging and then send a
package of the log files for analysis. You can use the tools available through the UC Analytics to do this.
To enable the button that allows you to create the support package, you must run the UC Analytics.exe installer file
from the installation directory (C:\Program Files\Quest\UC Analytics).
The Tools menu also provides an option that lets you regenerate TLS/SSL certificates for the Storage Engine and
the Query Engine when the certificates have been corrupted.

To create a support package or regenerate certificates

1 Start the installer by double-clicking the UC Analytics.exe file.
- OR -
From the Start menu, select Programs | Quest UC Analytics | UC Analytics | Deployment
Manager.exe.
2 Click Tools.
3 Select the option that you want:

Table 34. Deployment manager tool options.

Option Name Function

Set Detailed Logging Allows you to set detailed logging for the selected service.
Detailed logging includes informational messages in addition to the
default logging level which includes errors and warnings.
Create Support Package After you have run the product and reproduced the issue with
detailed logging, you can use this option to create a zipped file that
contains the log files.
The zipped file, which is named UC Analytics Support.zip, is copied
to the desktop.
NOTE: In a distributed installation, you must run the Create Storage
Package option on the server that has the Data Engine service
installed.
Regenerate Certificates Use this option to regenerate the TLS/SSL certificates used by the
Storage Engine and Query Engine if they become corrupted.
Keystore and Truststore certificates can become corrupted in certain
circumstances, such as when the Storage Engine or Query Engine
folders are not excluded from your antivirus software.

Unified Communications Analytics 8.5 Deployment Guide

114
Making changes to your deployment
 A
Appendix A:
Configuring Impersonation
Any credentials that are used to collect data using the Exchange Mailbox Contents or the Exchange Online
Mailbox Contents data sources must have application impersonation rights or “Exchange Impersonation”
permissions to all the target mailboxes:
• For information about how to set Exchange impersonation for Exchange 2013 or Exchange 2016, see
Setting impersonation for Exchange 2013 or Exchange 2016 on page 115.
• For information about how to set Exchange impersonation for Exchange 2010, see the following Microsoft
article: Configuring Exchange Impersonation.
• For information about how to set impersonation for Office 365, see Setting impersonation for Office 365 on
page 116.

Setting impersonation for Exchange

2013 or Exchange 2016
To collect data from Exchange 2013 or Exchange 2016, the credentials used to collect Exchange data must have
Application Impersonation rights for the mailboxes from which you are collecting.

To set impersonation for the collection credentials

1 Open the web-based Exchange Admin Center (EAC) for your Exchange server.
2 Click Permissions.
3 Under Admin Roles, click +.
4 Enter a name for the new role group, such as Impersonation for Exchange.
5 Under the Roles heading, click +.
6 Select ApplicationImpersonation and click add->.
7 Click OK.
8 Under the Users heading, click +.
9 Select an account to be used to collect the mailbox contents data from Exchange 2013 or Exchange 2016
and click OK.
Ensure that all the accounts you are using for Exchange Mailbox Contents data collections are added to
this role group.
10 Click Save.

Unified Communications Analytics 8.5 Deployment Guide

115
Appendix A: Configuring Impersonation
Setting impersonation for Office 365
To collect data from Exchange Online (Office 365) using the Exchange Online Mailbox Contents data source, the
credentials used to collect the data must have Application Impersonation rights. The account must be assigned to
a Role-Based Access Control group that has Application Impersonation rights. By default, no groups have
Application Impersonation rights in Office 365.
You must sign in as an administrator to the Office 365 portal and add this right either to an existing role group or to
a new role group that you create.
For example, you could create a new role group named Impersonation for Office 365 and add the Application
Impersonation right to the group.

To create a role group with impersonation rights and assign members

1 Log into the Office 365 Exchange Admin Center (EAC).
2 In the navigation tree on the left, select permissions.
3 Click admin roles.
4 Click the + Icon to add a new role group.
5 In the New Role Group dialog, enter the name for your new role group such as Impersonation for Office
365.
6 Under the Roles heading, click the + Icon to add a role.
7 Select ApplicationImpersonation from the list of roles
8 Click Add and click OK.
9 On the New Role Group dialog, under the Members heading, click the + icon to add a new member.
10 Select the account to be used for impersonation.
Ensure that all the accounts you are using for Exchange Online Mailbox Contents data collections are
added to this role group.
11 Click Add and click OK.
12 Click Save.

Unified Communications Analytics 8.5 Deployment Guide

116
Appendix A: Configuring Impersonation
 B
Appendix B:
Configuring the Skype for Business
or Lync Server
For UC Analytics to collect statistical data from a Skype for Business or a Lync server, the Monitoring role must be
installed on the Skype for Business or Lync server and Call Detail Recording (CDR) must be enabled and running.
See the following sections for the steps to configure your Lync or Skype for Business server.
Configuring Lync Server 2010
Configuring Lync Server 2013 or Skype for Business 2015

Configuring Lync Server 2010

Microsoft Lync Server gathers statistical data through the Monitoring role and from Active Directory. To collect data
from Lync 2010 server, you must install and enable the Monitoring server role on your Lync server.
The procedures are divided into the following parts:
1. Adding the SQL store for monitoring
2. Installing the Monitoring role
3. Enabling Call Detail Recording (CDR)
4. Starting the monitoring services

1. Adding the SQL store for monitoring

As a prerequisite, you must have created a SQL instance which will be used to store the monitoring records. Then
you can add your instance to the SQL store in Topology Builder.

To add the SQL store used for monitoring

1 In the Lync Topology Builder, select SQL Store | New SQL Store.
2 Enter the FQDN for the SQL Server and the SQL instance name (if you are not using the default instance).
3 Verify that the new store appears under the SQL stores folder.

2. Installing the Monitoring role

After you extract the .iso file on the Lync server on which you want to install the monitoring server role, you can run
the appropriate .msi files to install the roles.

Unified Communications Analytics 8.5 Deployment Guide

117
Appendix B: Configuring the Skype for Business or Lync Server
To install the monitoring server role on the Lync server
1 Navigate to the following file path:
\Setup\amd64\Setup\monitoringserver.msi
2 Double-click the monitoringserver.msi file.
3 Follow the steps in the wizard to complete the installation.

3. Enabling Call Detail Recording (CDR)

For your Lync server, you enable call detail recording (CDR) by setting the global properties for the associated
forest. CDRs are logs of usage statistics from conferences, instant messaging, and phone sessions that take place
across your Lync servers.

To enable CDR on your Lync server

1 In the Start menu, select Lync Server Control Panel.
2 Select Monitoring and Archiving in the list on the left side of the panel.
3 Click the Call Detail Recording tab.
4 Double-click Global.
5 Select the following check box:
▪ Enable monitoring of call detail recordings (CDRs)

4. Starting the monitoring services

After you have enabled and configured monitoring, you must start the monitoring services.

To start services on your Lync server

1 In the Start menu, select Lync Server Control Panel.
2 Select Topology in the list on the left side of the panel.
3 Click the Status tab and select the appropriate Lync server.
4 Select Action | Start all services.
You can verify that the monitoring services have started using the Services MMC tool or using Services
Manager.

Configuring Lync Server 2013 or Skype

for Business 2015
As of Lync Server 2013, the Monitoring role and the Archiving role no longer exist as separate roles. Both the
monitoring and archiving services are collocated on each Front-End server. In Skype for Business Server 2015,
monitoring is enabled or disabled on a pool-by-pool basis.
The procedures are divided into the following parts:
1. Associating the store with the Front-End pool
2. Updating the Lync or Skype for Business Server
3. Enabling and configuring monitoring

Unified Communications Analytics 8.5 Deployment Guide

118
Appendix B: Configuring the Skype for Business or Lync Server
 4. Starting the monitoring services

Prerequisite
As a prerequisite, you must have created a SQL instance which will be used to store the monitoring records.
During configuration you will associate the SQL instance with the Front-End Lync server on which the monitoring
services will run.

1. Associating the store with the Front-End

pool
You must associate a monitoring store (database) with the Front-End pool. A single monitoring store can be
associated with multiple pools.
The monitoring store is used to collect call detail recording (CDR). Call detail recording tracks the usage of Lync
server activities such as Voice over IP (VoIP) phone calls; instant messaging (IM); file transfers; audio/video (A/V)
conferencing; and application sharing sessions.
In this procedure, the Standard Edition Server is referenced. The same procedure is also used for the Enterprise
version.

To associate the store with the Front-End pool and publish the topology
1 Open the Topology Builder.
2 Select Standard Edition Front-End and select the Lync or Skype for Business server.
3 Right-click and select Edit Properties.
4 Select the Monitoring (CDR and QoE metrics) check box and click New.
5 In the Define New SQL Server Store dialog, enter the FQDN for the SQL Server and the SQL instance
name (if you are not using the default instance).
6 Click OK.
7 Review SQL server information for the Monitoring database and click OK.
8 Select the Lync server, right-click and select Topology.
9 Select Publish.

2. Updating the Lync or Skype for Business

Server
Now you must update the server to include the monitoring store information. From the installation path or from
your application DVD, run the Setup.exe file. (For a 64-bit server, the file path would be Setup | AMD64 |
Setup.exe.)

To update the Lync Server

1 In the Deployment Wizard, select Install or Update Lync Server System.
The wizard now updates the Front-End server to include the changes that you made in the Topology
Builder.

To update the Skype for Business Server

1 In the Deployment Wizard, click Install or Update Skype for Business Server System.

Unified Communications Analytics 8.5 Deployment Guide

119
Appendix B: Configuring the Skype for Business or Lync Server
 2 On the Deploy page, under Step 2: Setup or Remove Skype for Business Server Components, click Run
Again.
3 In the Setup Skype for Business Server components wizard, on the Setup Skype for Business Server
components page, click Next.
4 On the Specify path to MSIs page, type the path to the file Ocscore.msi (a file included with your Skype for
Business Server installation media) and click Next.
5 On the Executing Commands page, click Finish.

3. Enabling and configuring monitoring

Now you can enable and configure monitoring (CDR).

To enable monitoring on the Lync or Skype for Business server

1 Open the Lync or Skype for Business Server Control Panel and select Monitoring and Archiving in the
left panel.
2 In the Call Detail Recording tab, double-click the Global default policy and ensure that Enable Monitoring
of CDRs is selected.
3 Now you must enable CDR:
▪ For Lync, click Commit.
▪ For Skype for Business, click the appropriate site from the table, click Action, and then click Enable
CDR.

4. Starting the monitoring services

After you have enabled and configured monitoring, you must start the monitoring services.

To start services on your server

1 In the Start menu, select Lync Server Control Panel or select the Skype for Business Server Control
Panel.
1 Select Topology in the list on the left side of the panel.
2 Click the Status tab and select the appropriate server.
3 Select Action | Start all services.
If the services are already running, stop and then start the services. You can verify that the monitoring
services have started using the Services MMC tool or using Services Manager.

Unified Communications Analytics 8.5 Deployment Guide

120
Appendix B: Configuring the Skype for Business or Lync Server
 C
Appendix C:
Configuring IIS Log Files to capture
ActiveSync or OWA events
• Configuring IIS Logging on the Exchange CAS and Mailbox servers
• Configuring IIS if Exchange is hosted on Windows 2003 Server
• Configuring IIS Logging if Exchange is hosted on Windows Server 2008 or later
• What ActiveSync events are collected and displayed in the insights?

Configuring IIS Logging on the

Exchange CAS and Mailbox servers
For UC Analytics to collect data from the ActiveSync IIS log files, IIS logging must be configured on the front-end
Exchange Client Access Server (CAS) and on the back-end Exchange Mailbox servers to include the required
data. You configure IIS logging on the servers that have the ActiveSync role installed.
UC Analytics only supports the following log file format:
• W3C Extended Log File Format (set by default)
UC Analytics does not support a weekly, monthly, or yearly frequency for IIS log file rollover. Only hourly or daily
log file rollover is supported.
When using W3C Extended Log File Format, you must configure the extended properties. The default
configuration of IIS logging for the W3C Extended Log File Format is insufficient for UC Analytics to gather the
information required for insights.
Use IIS Manager to configure the W3C Extended Log File Format on the Exchange CAS server from which you
want to gather data. If the Exchange CAS server is hosted on Window Server 2008, Windows Server 2008 R2, or
Windows Server 2012, see Configuring IIS Logging if Exchange is hosted on Windows Server 2008 or later on
page 123.

Configuring IIS if Exchange is hosted on

Windows 2003 Server
Use the following procedure to configure IIS logging if Exchange is hosted on a Windows 2003 server.

To configure IIS logging on Exchange hosted on a Windows 2003 server

If you do not have the Internet Information Services (IIS) Manager MMC snap-in added, start at step 1.
If the snap-in is already installed, start at step 7.

Unified Communications Analytics 8.5 Deployment Guide

121
Appendix C: Configuring IIS Log Files to capture ActiveSync or OWA events
1 From the Start menu, select Run.
2 Type mmc, and click OK.
3 In the Console dialog box, select File | Add/Remove Snap-in.
4 Click Add.
5 Select Internet Information Services and click Add.
6 Click Close and click OK.
7 In the treeview, browse to the Web Sites node.
8 Right-click the web site that you want and select Properties.
9 On the Web Site property sheet, click Properties in the Enable Logging section.
10 Select the Advanced Properties tab.
11 To collect ActiveSync events, ensure that the following fields are selected:
▪ Date (date)
▪ Time (Time)
▪ User Name (cs-username)
▪ Server name (s-computername)
▪ Server IP Address (s-ip)
▪ URI Stem (cs-uri-stem)
▪ URI Query (cs-uri-query)
▪ Protocol Status (sc-status)
▪ Bytes Sent (sc-bytes)
▪ Bytes Received (cs-bytes)
▪ Time Taken (time-taken)
▪ User Agent (cs(User-Agent))
▪ Protocol Substatus (sc-substatus)
12 To collect Outlook on the Web (OWA) logons, ensure that the following fields are selected:
▪ Date (date).
▪ Time (time):
▪ User Name (cs-username):
▪ Method (cs-method)
▪ URI Stem (cs-uri-stem)
▪ Protocol Status (sc-status)
▪ User Agent (cs(User-Agent))
▪ Cookie (cs(Cookie)).
▪ Referer (cs(Referer))
▪ Server IP Address (s-ip):
▪ Server Name (s-computername)
▪ Client IP Address (c-ip):
13 Click OK.
14 Under the General tab, ensure that the New Log Schedule is set to hourly or daily. UC Analytics does not
support weekly, monthly, or unlimited log file size for the log file rollover schedule.

Unified Communications Analytics 8.5 Deployment Guide

122
Appendix C: Configuring IIS Log Files to capture ActiveSync or OWA events
 15 Click OK and close the console.

Configuring IIS Logging if Exchange is hosted

on Windows Server 2008 or later
If you have Exchange hosted on Windows Server 2008 or Windows Server 2008 R2 (IIS 7), or Windows Server
2012 (IIS 8), you must install the IIS Management Scripts and Tools on the Exchange CAS server. The IIS
Management Scripts and Tools are required to allow UC Analytics to gather the IIS log files.
You must also configure the W3C Extended Log File Format for IIS logging on the Exchange server.

To configure IIS logging on Exchange hosted on Windows 2008 Server or later

1 Click Start and select Administrative Tools | Internet Information Services (IIS) Manager.
- OR -
In the Server Manager, select the Web Server (IIS) and open the Internet Information Services (IIS)
Manager.
2 On the left, open the dropdown menu under the Start Page option.
3 Select the default Web Site.
4 Double-click Logging.
5 On the Logging page, in the Log file section set the Format to W3C and click Select Fields.
6 To collect ActiveSync events, ensure that the following W3C Logging fields are selected:
▪ Date (date)
▪ Time (time)
▪ User Name (cs-username)
▪ Server name (s-computername)
▪ Server IP Address (s-ip)
▪ URI Stem (cs-uri-stem)
▪ URI Query (cs-uri-query)
▪ Protocol Status (sc-status)
▪ Bytes Sent (sc-bytes)
▪ Bytes Received (cs-bytes)
▪ Time Taken (time-taken)
▪ User Agent (cs(User-Agent))
▪ Protocol Substatus (sc-substatus)
7 To collect Outlook on the Web (OWA) logons, ensure that the following W3C Logging fields are selected:
▪ Date (date).
▪ Time (time):
▪ User Name (cs-username):
▪ Method (cs-method)
▪ URI Stem (cs-uri-stem)
▪ Protocol Status (sc-status)
▪ User Agent (cs(User-Agent))

Unified Communications Analytics 8.5 Deployment Guide

123
Appendix C: Configuring IIS Log Files to capture ActiveSync or OWA events
 ▪ Cookie (cs(Cookie)).
▪ Referer (cs(Referer))
▪ Server IP Address (s-ip):
▪ Server Name (s-computername):
▪ Client IP Address (c-ip):
8 Click OK.
9 If you are running IIS 8.5 on Windows Server 2012 R2 or later, ensure that the Log Event Destination is set
one of the following:
▪ Log file only
- OR -
▪ Both log file and ETW event
10 Under the Log File Rollover section, ensure that a schedule of hourly or daily is selected. UC Analytics
does not support weekly, monthly, or yearly log file rollover time periods.

What ActiveSync events are collected

and displayed in the insights?
If you have configured your Exchange CAS servers as described in this appendix, you can view data about
different types of ActiveSync events in the insights.

To see the event type in an insight, click the details browser icon in the top right corner of the main insight.
The following events are collected and displayed in the ActiveSync insights.

Table 35. ActiveSync event types that are collected and reported.

Event Type Description

Sync Synchronizes the changes in a folder between the client and the server.
SendMail Sends mail to the server. This command is issued in the HTTP POST command's
URI and does not contain an XML body. The body contains the MIME message
instead.
SmartForward Forwards a message object without retrieving the full message object from the
server.
SmartReply Replies to a message object without retrieving the full message object from the
server.
GetAttachment Retrieves an email attachment from the server.
FolderSync Synchronizes the folder hierarchy but does not synchronize the items in the folders.
FolderCreate Creates an email, calendar, or contacts folder on the server.
FolderDelete Deletes a folder from the server.
FolderUpdate Moves a folder from one location to another location on the server and is used to
rename folders.
MoveItems Moves items from one folder to another.
GetItemEstimate Gets an estimate of the number of items in a folder that is synchronized.
MeetingResponse Used to accept, tentatively accept, or decline a meeting request in the user's Inbox
folder.
Search Finds and retrieves information about contacts and recipients in the Global Address
List (GAL).

Unified Communications Analytics 8.5 Deployment Guide

124
Appendix C: Configuring IIS Log Files to capture ActiveSync or OWA events
Table 35. ActiveSync event types that are collected and reported.

Event Type Description

Settings Supports getting and setting global properties, such as Out-of-Office (OOF) and
device information.
Ping Requests that the server monitor all specified folders for changes that require the
client to resynchronize.
ItemOperations Identifies the body of a request or response as containing a set of commands
operating on items.
Provision Gets the security policy settings set by the server administrator, such as the user's
minimum password length requirement.
ResolveRecipients Resolves a list of supplied recipients and, optionally, fetches their S/MIME
certificates so that clients can send encrypted messages.
ValidateCert Validates a certificate that has been received through an S/MIME mail.
HealthCheck Internal access from Microsoft Exchange to check the health of the ActiveSync
service.

The ActiveSync data collector skips any IIS log entries for ActiveSync events that are missing critical fields. The
collector writes partial information for ActiveSync events that are missing non-critical fields.

Table 36. Critical and non-critical fields in ActiveSync event entries.

Critical Fields Non-Critical Fields

date sc-bytes
time cs-bytes
cs-uri-stem cs-username
cs-uri-query s-computername
sc-status s-ip
time-taken
cs(User-Agent)
sc-substatus

If you see error or warnings in the data collection status for Exchange IIS Logs jobs that indicate there are missing
fields, ensure that all of the recommended W3C logging fields were selected when you configured IIS logging on
your Exchange CAS server.
For more information, see Configuring IIS if Exchange is hosted on Windows 2003 Server on page 121 and
Configuring IIS Logging if Exchange is hosted on Windows Server 2008 or later on page 123.

Unified Communications Analytics 8.5 Deployment Guide

125
Appendix C: Configuring IIS Log Files to capture ActiveSync or OWA events
 D
Appendix D:
PowerShell cmdlets used by data
sources
This section contains information about the PowerShell cmdlets that are used by the different data sources to
collect data that is used in the insights.
Exchange configuration data source
Exchange public folder data source
Skype for Business/Lync configuration data source
Exchange Online hybrid and native user configuration data sources
Exchange Online hybrid and native mailbox configuration data sources
Exchange Online mailbox contents data source
Office 365 user subscription configuration data source

Exchange configuration data source

The Exchange configuration data source uses the following PowerShell cmdlets when collecting Exchange
configuration data:
• Get-ExchangeServer
• Get-MailboxDatabase –status
• Get-PublicFolderDatabase –status
• Get-MailboxDatabaseCopyStatus –Server (Exchange 2010/Exchange 2013/Exchange 2016)
• Get-Mailbox
• Get-MailboxStatistics
• Get-MobileDeviceStatistics (Exchange 2013/Exchange 2016)
• Get-MobileDevice (Exchange 2013/Exchange 2016)
• Get-ActiveSyncDeviceStatistics (Exchange 2010)
• Get-ActiveSyncDevice (Exchange 2010)
• Get-MailboxPermission

Unified Communications Analytics 8.5 Deployment Guide

126
Appendix D: PowerShell cmdlets used by data sources
Exchange public folder data source
The Exchange public folders data source uses the following PowerShell cmdlets when collecting Exchange public
folder data:
• Get-PublicFolderDatabase
• Get-PublicFolder
• Get-PublicFolderStatistics

Skype for Business/Lync configuration

data source
The Skype for Business/Lync configuration data source uses the following PowerShell cmdlets when collecting
Lync configuration data:
• Get-CsArchivingPolicy
• Get-CsConferencingPolicy
• Get-CsExternalAccessPolicy
• Get-CsComputer
• Get-CsPool
• Get-CsService
• Get-CsUser

Exchange Online hybrid and native

user configuration data sources
Both the Exchange Online hybrid and native user configuration data sources use the following PowerShell cmdlets
when collecting Exchange user configuration data from Office 365:
• Get-Mailbox
• Get-Group
• Get-DynamicDistributionGroup
• Get-Contact
• Get-User
• Connect-MsolService
• Get-MsolUser

Unified Communications Analytics 8.5 Deployment Guide

127
Appendix D: PowerShell cmdlets used by data sources
Exchange Online hybrid and native
mailbox configuration data sources
Both the Exchange Online hybrid and native mailbox configuration data sources use the following PowerShell
cmdlets when collecting Exchange mailbox configuration data from Office 365:
• Get-Mailbox
• Get-Group
• Get-DynamicDistributionGroup
• Get-User
• Get-Recipient
• Get-MailboxStatistics
• Get-MailboxPermission
• Get-RecipientPermission
• Get-MobileDeviceStatistics
• Connect-MsolService
• Get-MsolUser

Exchange Online mailbox contents data

source
The Exchange Online mailbox contents data source uses the following PowerShell cmdlets when collecting
Exchange mailbox contents data from Office 365:
• Get-Group
• Get-DynamicDistributionGroup
• Get-User
• Get-Recipient

Office 365 user subscription

configuration data source
• Connect-MsolService
• Get-MsolUser

Unified Communications Analytics 8.5 Deployment Guide

128
Appendix D: PowerShell cmdlets used by data sources
 E
Appendix E:
Custom configurations and backup
and recovery options
This section contains information about how to handle specific situations. See the following topics for instructions
about how to configure UC Analytics to meet certain requirements.
Setting up a multi-forest environment with a one-way trust
Firewall configuration: ports for data collection
Backing up and restoring your data using scripts
Scheduling the backup batch file to run automatically
Performing a manual backup of the storage folder before upgrade
Moving your storage location
Recommendations for disaster recovery
Setting a custom title page for exported or subscription insights
Changing the interval time before job status is purged
Configuring remote PowerShell to use the required proxy settings
Overriding PowerShell credential winnowing

Setting up a multi-forest environment

with a one-way trust
You can configure UC Analytics to support multiple forests that have a one-way trust. In the following example of a
one-way trust scenario, the forests are configured as follows:
• Forest A - Admin forest contains Active Directory users
• Forest R - Resource forest (all mailboxes are here).
• Forest R trusts Forest A.
UC Analytics is installed in the resource forest (Forest R). The UC Analytics Data Engine service is running with
Forest R credentials. For this scenario, you would perform the following steps to allow users from the trusted
domain (Forest A) to access UC Analytics:
1 Add a second target environment that points to the trusted domain.
2 Specify an account from the trusted domain as the Authentication Credential that is used to authenticate a
user (User X) in Forest A and allows access to UC Analytics.
▪ The credential must have read rights to the Active Directory forest specified in the Forest A
environment.

Unified Communications Analytics 8.5 Deployment Guide

129
Appendix E: Custom configurations and backup and recovery options
 ▪ The credential must have sufficient rights to browse users and groups and to resolve group
memberships for all users and groups from this environment that are specified in the Security
settings.
Once the second environment (for Forest A) is added and an authentication account from Forest A is specified for
authentication, User X can log on to UC Analytics. For information about adding target environment for an
additional Active Directory forest, see Adding multiple Active Directory forests on page 31.
User X can view the data in the insights based on the security permissions that were granted to the ForestA\Group
in the Security settings. When you add users in the Security settings, ensure that the Forest A target environment
is selected when you add the Forest A users. For information about the Security settings, see Granting users
access to data on page 45.

Firewall configuration: ports for data

collection
When you configure your firewall, UC Analytics requires access to the following TCP and UDP ports for Exchange
2010 and later:

Table 37. Ports required for data collection

Network access Required ports

Microsoft file sharing SMB (Server Message Block) TCP/UDP 135-139
Direct-hosted SMB traffic TCP/UDP 445
LDAP (Lightweight Directory Access Protocol) TCP/389
Active Directory Lookups
Kerberos TCP/UDP 88
LDAP Global Catalog TCP/3268
DNS (Domain Name System) TCP/UDP 53
WINS (Windows Internet Name Service) TCP/UDP 137
Remote PowerShell for Exchange TCP Port 80 and access to the IIS PowerShell virtual
directory on your Exchange servers
Remote PowerShell for Skype for Business/Lync TCP Port 443 and access to the IIS OcsPowerShell virtual
directory on your Skype for Business/ Lync Servers

If you have implemented an intelligent firewall, you can configure the firewall to allow the specific types of network
access (SMB, LDAP, and so on) that UC Analytics requires instead of access to specific ports.

Ports used for service-to-service

communication in a distributed installation
In a distributed installation where you have a multiple UC Analytics servers deployed and there are firewalls
between the UC Analytics servers, certain ports are required for service-to-service communication.
• For the Storage Engine and the Query Engine, open the following TCP ports: 1223, 7100, 7101, 7299,
9042, 9260, and 10099.
• For the Data Engine, open the following TCP ports: 1336 and 1337.

Unified Communications Analytics 8.5 Deployment Guide

130
Appendix E: Custom configurations and backup and recovery options
Backing up and restoring your data
using scripts
UC Analytics provides two scripts (batch files) that allow you to back up data from your UC Analytics Storage
Engine. The backup batch file uses the “snapshot” command that is included in the Cassandra nodetool utility.
When you run the backup script, you take a snapshot of all your stored data while the Storage Engine service is
running. When you take a snapshot, you are backing up your data at a specific point in time.
NOTE: This will temporarily double the amount of data in your Storage directory while the batch file runs.
Supported scenarios
About the backup and restore batch files
Step 1: Edit the backup.bat file parameters for your installation
Step 2: Run the backup batch file
Step 3: Edit the restore batch file
Step 4a: Restore the storage data in an existing installation
Step 4b: Restore the storage data to a new installation
For information about creating a task to back up your data automatically, see Scheduling the backup batch file to
run automatically on page 135.

Supported scenarios
The following scenarios are supported by the backup and restore scripts:
• You can back up an existing installation and restore to the same installation
• You can back up an existing installation and restore to a new installation.The Data Engine and Query
Engine roles installed in a new installation can be different than the original installation. However, the new
installation must meet the following criteria:
▪ have the same number of installed Storage Engines as the old installation
▪ use the same time zone settings on all Storage Engines as the old installation. UC Analytics
performs the backup using a date-related label.
▪ have the same server name and IP address as the old installation in which the backup was created.
For example, any of the following installations could be backed up and interchangeably restored:
Scenario 1
Server A: All components - Web Site, Data Engine (Insights), Query Engine (Insights), Data Engine
(collector role, Query Engine (Collector), Storage Engine.
Server B: Storage Engine
Scenario 2
Server A: Web Site, Data Engine (Insights), Query Engine (Insights), Storage Engine
Server B: Data Engine (Collector), Query Engine (Collector), Storage Engine
Scenario 3
Server A: Web Site, Data Engine (Insights), Data Engine (Collector), Storage Engine
Server B: Query Engine (Insights), Query Engine (Collector), Storage Engine

Unified Communications Analytics 8.5 Deployment Guide

131
Appendix E: Custom configurations and backup and recovery options
What is backed up by the backup script?
All your configuration and collected data is backed up when you run the backup script. When you run the restore
script, the configuration and collected data are restored to the state when backup was created.
The backup process saves data from all the tables in the \Storage\data\Doradus folder and creates a separate
subdirectory for each saved table. Each snapshot directory contains numerous files of data captured at the time of
the snapshot. The backup process also saves configuration data from the \Storage\data\System folder.
The batch file then copies the snapshot data created to the backup folder (named based on the current date and
time), then removes the snapshot directories from the original Storage folder.

About the backup and restore batch files

In the UC Analytics installation path, there is a folder named Storage Engine Backup Scripts. By default, the
directory is located in the following path:
C:\Program Files\Quest\UC Analytics\Storage Engine Backup Scripts
The folder contains two batch files:
• backup.bat
• restore.bat
The folder also contains several PowerShell script files:
• BackupScript.ps1
• PurgeScript.ps1
• RestoreScript.ps1
To use the scripts, copy all the files to the folder on each server that hosts the UC Analytics Storage Engine. If you
have multiple storage nodes, you must run the script on each node. All nodes must be in the same time zone.

Prerequisites
To run the backup and restore batch files, you must have PowerShell 3.0 or later installed on the server that hosts
the UC Analytics Storage Engine.
To run the backup.bat file to create the backup, all the UC Analytic services must be running.
For deployments with multiple storage nodes, the scripts must be run on each node. All nodes must be within the
same time zone.
The prerequisites for running the restore.bat differ depending whether you are restoring to the existing installation
or to a new installation.

IMPORTANT: On Windows Server 2016, you must open a cmd window as Administrator to run the scripts.

Step 1: Edit the backup.bat file parameters for

your installation
After you have copied all the backup and restore files to the server that hosts the UC Analytics Storage Engine,
you must edit the backup.bat file to specify the parameters for your environment.
The backup.bat file looks as follows:
-storageEngineDirectoryPath "C:\Program Files\Quest\UC Analytics\Storage Engine\bin" -storageDirectoryPath
"C:\Program Files\Quest\UC Analytics\Storage" -backupDirectoryPath "c:\UCA\backup" -backupLabel "label" -
portNumber 7299 -numberOfBackupCopies 2 -force

Unified Communications Analytics 8.5 Deployment Guide

132
Appendix E: Custom configurations and backup and recovery options
The parameters that you can edit are as follows:

Table 38. Backup batch file parameters

Parameter Default value Required information

storageEngineDirectoryPath C:\Program Files\Quest\UC Shows the location of the storage engine. If you
Analytics\Storage Engine\bin installed using the default values, you can leave
this parameter as shown.
storageDirectoryPath C:\Program Files\Quest\UC Shows the location of the storage folder. If you
Analytics\Storage installed using the default values, you can leave
this parameter as shown.
backupDirectoryPath c:\UCA\backup Enter the path and folder name for the folder to
which you want to copy the backup files.
You can enter a UNC path if you are copying the
backup files to a different server or share.
backupLabel label Enter a unique name to identify the storage
folder and server that contains the Storage
Engine data that you want to back up.
For example, you could enter Store1Server1.
portNumber 7299 Port used by the Cassandra nodetool.
numberOfBackupCopies 2 Enter the number of backup copies that will be
retained at any one time. The backup folders are
date-stamped so if you are retaining two copies,
the two newest folders are kept and any older
copies are removed.

NOTE: Do not change the port number from 7299. This is the port that is used by the Cassandra nodetool.

Step 2: Run the backup batch file

Once you have edited the backup.bat file to contain your local values, you can run the file to create a backup copy
of your data. The backup script automatically detects the path to the latest version of Java that is installed on the
computer.
You run the backup batch file locally on the server on which the Storage Engine resides.

To create a snapshot backup file

1 Ensure that all the UC Analytics services are running.
2 Navigate to the folder that contains the backup and restore script files.
3 Open the command prompt and enter:
backup.bat
The batch file creates a folder with the current date in YYYY-MM-DD format that contains subfolders with files that
contain the data structure information and files that contain the actual data.

Step 3: Edit the restore batch file

Before you restore a backup file, you must edit the restore.bat file to specify the parameters for your environment.
The restore.bat file looks as follows:
-backupDirectoryPath "c:\UCA\backup" -backupLabel "label" -backupDate "YYYY-MM-DD" -storageDirectoryPath
"C:\Program Files\Quest\UC Analytics\Storage" -storageEngineDirectoryPath "C:\Program Files\Quest\UC
Analytics\Storage Engine\bin" -portNumber 7299

Unified Communications Analytics 8.5 Deployment Guide

133
Appendix E: Custom configurations and backup and recovery options
The parameters that you can edit are as follows:

Table 39. Restore batch file parameters

Parameter Default value Required information

backupDirectoryPath C:\UCA\backup Enter the path and folder name for the folder to
which the backup batch file previously copied
the backup files.
backupLabel label Enter the unique name that was assigned as the
backup label when the backup was created.
The label name must exactly match the name
that was entered in the backup.bat file when the
backup was created.
backupDate YYYY-MM-DD Enter the date for the backup file from which you
want to restore the data.
The backup folder is named with the date of the
backup in YYYY-MM-DD format.
storageDirectoryPath C:\Program Files\Quest\UC Shows the location of the storage folder. If you
Analytics\Storage installed using the default values, you can leave
this parameter as shown.
storageEngineDirectoryPath C:\Program Files\Quest\UC Shows the location of the storage engine. If you
Analytics\Storage Engine\bin installed using the default values, you can leave
this parameter as shown.
portNumber 7299 Port used by the Cassandra nodetool.

NOTE: Do not change the port number from 7299. This is the port that is used by the Cassandra nodetool.

Step 4a: Restore the storage data in an existing

installation
Use this procedure to restore your existing database if the data has become corrupted.
When you restore data from a snapshot, there is intensive processor and I/O activity on the node that is being
restored. You run the backup batch file locally on the server on which the Storage Engine resides.

To restore a snapshot backup file in the same installation

1 Stop the UC Analytics services on all the servers in the deployment in the following order:
▪ Data Engine
▪ Query Engine
▪ Storage Engine
2 Navigate to the folder that contains the backup and restore script files.
3 Open the command prompt and enter:
restore.bat
4 Restart all the UC Analytics services in the following order:
a Storage Engine.
b Query Engine
c Data Engine

Unified Communications Analytics 8.5 Deployment Guide

134
Appendix E: Custom configurations and backup and recovery options
Step 4b: Restore the storage data to a new
installation
Use this procedure to restore a database to a new installation.
When you restore data from a snapshot, there is intensive processor and I/O activity on the node that is being
restored. You run the backup batch file locally on the server on which the Storage Engine resides.

To restore a snapshot backup file in a new installation

1 Install UC Analytics. For information about the criteria that the new installation must meet, see Supported
scenarios on page 131.
If you have a distributed installation, you must specify the same number of Storage Engines as were
installed when the backup was performed.
2 Stop the UC Analytics services on all the servers in the deployment in the following order:
▪ Data Engine
▪ Query Engine
▪ Storage Engine
3 Navigate to the folder that contains the backup and restore script files.
4 Open the command prompt and enter:
restore.bat
5 Restart all the UC Analytics services in the following order:
a Storage Engine.
b Query Engine
c Data Engine

Scheduling the backup batch file to run

automatically
You can use the Windows task scheduler to run the backup batch file automatically on a regular basis. For
information about configuring the backup and restore batch files, see Backing up and restoring your data using
scripts on page 131.

IMPORTANT: The restore.bat file should only be run manually.

To set up a weekly schedule for backup

1 Start the Windows Task Scheduler.
2 Find and click the task folder in the console tree under which you want to create a folder.
a If you want to create a sub-folder in the root task folder, click the Task Scheduler Library folder.
b In the Actions pane, click New Folder.
c In the Enter name of the new folder dialog box, type the name of folder.
d Click OK.
3 In the Actions Pane, click Create Task.
4 Step through the details to establish the new schedule with the following settings:

Unified Communications Analytics 8.5 Deployment Guide

135
Appendix E: Custom configurations and backup and recovery options
 ▪ On the Triggers tab, set the schedule a trigger for once a week.
▪ Point the scheduled task to the backup.bat file provided by UC Analytics.
▪ Ensure that you configure the task to run at the highest level.

Using the -force parameter

In the backup.bat file, the parameter -force is useful if you have scheduled the batch file to run automatically as
part of a scheduled task. If a backup file of the same name is found in the backup directory path, -force causes the
script to overwrite the file without issuing a prompt saying that a duplicate file name has been detected.
If you are running the script manually, you might want to remove the -force parameter.

Performing a manual backup of the

storage folder before upgrade
Before you upgrade UC Analytics, it is recommended that you perform a manual backup of your storage folder. If
you have multiple Storage Engines deployed, you must take a backup of each storage folder on each server.

To perform a manual backup of the storage folder

1 Stop the following UC Analytics services:
▪ UC Analytics Query Engine
▪ UC Analytics Storage Engine
2 Navigate to the UC Analytics storage folder. By default, the directory is located in the following path:
C:\Program Files\<VendorName>\UC Analytics\Storage
3 Use a compression utility to compress the Storage folder, such as to a zipped file format.
4 Copy the compressed file to a separate location.

NOTE: It may take several hours to complete the manual copy.

This type of backup copy is different from the backup script. The backup script copies only the collected data, data
source configuration, and Admin settings. The backup script does not copy the Cassandra system files. To back
up all of the database, you must copy the entire storage folder.

Moving your storage location

You can move the location of your UC Analytics storage database within the same computer. When you move the
database, you must also change a number of places that point to the database.

To move the storage directory and configure the cassandra.yaml file for the new location
1 Stop the following UC Analytics services:
▪ UC Analytics Query Engine
▪ UC Analytics Storage Engine
2 Navigate to the UC Analytics installation folder. By default, the installation directory is located in the
following path:
C:\Program Files\Quest\UC Analytics\

Unified Communications Analytics 8.5 Deployment Guide

136
Appendix E: Custom configurations and backup and recovery options
 3 Move the directory named Storage to the new location.
4 Navigate to the following directory:
C:\Program Files\Quest\UC Analytics\Storage Engine\conf
5 Open the following text file for editing:
cassandra.yaml
6 Locate the following text in the file:
C:\Program Files\Quest\UC Analytics\Storage
You will find this text in three locations related to the data, the commitlog, and the saved_caches. Note that
this path name uses forward slashes, not back slashes.
7 In the three locations, change the path name to the new location you selected in Step 3.
8 Locate the following file in the Configuration directory:
C:\Program Files\Quest\UC Analytics\Configuration\DeploymentConfiguration.txt
9 In the Configuration.txt file, locate the following parameter:
"Settings":[{"Key":"StorageEnginePhysicalMemory","Value":"8192"},{"Key":"StorageDirectoryPath","Value":
"C:\\Program Files\\Quest\\UC Analytics\\Storage"},
10 Change {"Key":"StorageDirectoryPath","Value":"C:\\Program Files\\Quest\\UC Analytics\\Storage"} to
reflect the new path for the storage location.
11 Start the Query Engine and Storage Engine services.
TIP: If User Account Control (UAC) is on when you perform the procedure, UAC file virtualization might be
active when you try to update DeploymentConfiguration.txt and cassandra.yaml files. As a result, the actual
files in Program Files are not updated. In this case, you might have to temporarily disable UAC to update the
files.

Recommendations for disaster

recovery
For disaster recovery planning, there are two options that you can consider.
• Use redundant storage such as a RAID array when you install UC Analytics.
• Back up your configuration and data storage.

To back up the UC Analytics configuration and data

1 Stop all the UC Analytics services:
▪ UC Analytics Data Engine
▪ UC Analytics Query Engine
▪ UC Analytics Storage Engine
2 On each computer on which the Storage Engine is installed, back up your storage folder. By default, the
storage directory is located in the following path:
C:\Program Files\Quest\UC Analytics\Storage
3 Start all the UC Analytics services.

To restore the UC Analytics configuration and data

1 Stop all the UC Analytics services:

Unified Communications Analytics 8.5 Deployment Guide

137
Appendix E: Custom configurations and backup and recovery options
 ▪ UC Analytics Data Engine
▪ UC Analytics Query Engine
▪ UC Analytics Storage Engine
2 On each computer on which the Storage Engine is installed, restore your storage folder. By default, the
storage directory is located in the following path:
C:\Program Files\Quest\UC Analytics\Storage
3 Start all the UC Analytics services.

Setting a custom title page for exported

or subscription insights
When you export an insight (or create an insight subscription) that uses PDF or .docx format, the exported insight
displays UC Analytics and the Quest logo on the title page. You can customize the title page to include your own
logo and company name by editing a file called UC.Analytics.Insights.DataEngine.InsightLogic.dll.config.
The UC.Analytics.Insights.DataEngine.InsightLogic.dll.config file contains the following text:
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
<configSections>
<section name="insightRenderingConfiguration"
type="UC.Analytics.Common.General.Core.Configuration.SettingsNameValueCollection,
UC.Analytics.Common.General.Core"/>
</configSections>
<insightRenderingConfiguration>
<add name="exportLogoImageFilePath" value=""/>
<add name="exportTitle" value=""/>
</insightRenderingConfiguration>
</configuration>

When you edit the file and enter your own values, the characters that you enter in the value fields must use valid
XML characters. For certain characters, such as double quotation marks (“), ampersand (&), and apostrophe (‘),
you must escape the characters to have them render correctly on the title page.

Table 40. Using XML special characters

Name Character How entered in file

Double quotation marks “ &quot;
Apostrophe ‘ &apos;
Ampersand & &amp;
Less than < &lt;
Greater than > &gt;

To customize the title page for insight exports or subscriptions

1 On the server that hosts the UC Analytics Data Engine, navigate to the folder in which the Data Engine is
installed. By default, the Data Engine folder is located at:
C:\Program Files\Quest\UC Analytics\Data Engine

Unified Communications Analytics 8.5 Deployment Guide

138
Appendix E: Custom configurations and backup and recovery options
 2 Create a backup copy of the UC.Analytics.Insights.DataEngine.InsightLogic.dll.config file and save it to a
different location.
3 Using a text editor, open the UC.Analytics.Insights.DataEngine.InsightLogic.dll.config file.
Suppose that you want to show the company name Sitraka & Co. as the title and also include a graphic file
that is located at C:\Users\Admin\My Pictures\CompanyLogo.png.
4 You would edit the <add key> values as shown in the following example:
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
<configSections>
<section name="insightRenderingConfiguration"
type="UC.Analytics.Common.General.Core.Configuration.SettingsNameValueCollection,
UC.Analytics.Common.General.Core"/>
</configSections>
<insightRenderingConfiguration>
<add name="exportLogoImageFilePath" value="C:\Users\Admin\My
Pictures\CompanyLogo.png"/>
<add name="exportTitle" value="Sitraka &amp;Co."/>
</insightRenderingConfiguration>
</configuration>
5 Save your changes.
6 For the changes to take effect, restart the Data Engine service.

Changing the interval time before job

status is purged
By default, UC Analytics purges the job status summary information for a data collection job 30 days after the job
has run. UC Analytics purges the job status details information after 7 days. Depending on the size and number of
your data collections, you might want to modify the time periods that UC Analytics will keep job status summary
and details. You can configure UC Analytics to clean out job status details records separately from job status
summary records.
For example, you might decide to keep job status summary records for longer than the job status details records
since the details records will occupy much more space.
To change the time period for which UC Analytics will retain job run status summary and details records, you edit
the UC.Analytics.Insights.DataEngine.DataCollector.dll.config file.The configuration file is located in the data
engine directory on the server that hosts a data storage engine.

To modify the job status purge intervals

1 On the server that hosts the UC Analytics Data Engine, navigate to the folder in which the Data Engine
collector role is installed. By default, the Data Engine folder is located at:
C:\Program Files\Quest\UC Analytics\Data Engine
2 Create a backup copy of the UC.Analytics.Insights.DataEngine.DataCollector.dll.config file and save it to a
different location.
3 Using a text editor, open the UC.Analytics.Insights.DataEngine.DataCollector.dll.config file.
4 Locate the following text section in the file:

Unified Communications Analytics 8.5 Deployment Guide

139
Appendix E: Custom configurations and backup and recovery options
<purgeJobStatusJobSettings
enabled="true"
primaryCollectorOnly="true"
executionAlignmentTimeInMinutes="60"
executionFrequencyInMinutes="1440"
retentionPeriodInDays="30"

/>
5 To change the retention period for the job status details records, change the 30 beside
retentionPeriodInDays= to the number of days that you want retain the job status details data.
6 Save your changes.
7 For the changes to take effect, restart the Data Engine service.

Configuring remote PowerShell to use

the required proxy settings
For the Exchange Online data sources, if your environment requires explicit proxy settings to access the internet,
you must configure the Exchange Online data sources to use the required proxy settings.

To set the PowerShell proxy access type for the Exchange Online data collections
1 On the server that hosts the UC Analytics Data Engine, navigate to the folder in which the Data Engine
collector role is installed. By default, the Data Engine folder is located at:
C:\Program Files\Quest\UC Analytics\Data Engine
2 Create a backup copy of the UC.Analytics.Insights.DataEngine.DataCollector.dll.config file and save it to a
different location.
3 Using a text editor, open the UC.Analytics.Insights.DataEngine.DataCollector.dll.config file.
4 Locate the following text in three locations in the Dell.UC.Insights.DataEngine.DataCollector.dll.config file:
powerShellProxyAccessType="None"
5 Modify the text to use the proxy setting that you want. The setting will be one of the following:
▪ IEConfig
▪ WinHttpConfig
▪ AutoDetect
▪ NoProxyServer:
For example, if you want the Exchange Online collectors to create the remote PowerShell sessions using
the IE proxy configuration settings of the service account, you would set the following:
powerShellProxyAccessType="IEConfig"
These settings affect all Exchange Online data sources that use a remote PowerShell connection.
For more information about the Microsoft PowerShell proxy settings, search for New-PSSessionOption in the
Microsoft PowerShell documentation web site.

Unified Communications Analytics 8.5 Deployment Guide

140
Appendix E: Custom configurations and backup and recovery options
Overriding PowerShell credential
winnowing
In the Exchange Online Hybrid Mailbox Configuration and the Exchange Online Native Mailbox Configuration data
sources, you can specify multiple credentials that are used to connect to Exchange Online using remote
PowerShell. Sometimes, an invalid credential might be specified such as an incorrect password.
When UC Analytics connects to Exchange Online through PowerShell, if a credential cannot connect, it assumes
the credential is invalid and removes the credential from the list of credentials that is being used to connect. This
process of removing invalid credentials is called “winnowing”. However, in some cases the credential may be valid
and inability to connect is caused by Microsoft throttling of the PowerShell connections.
If you are sure all the PowerShell credentials you have specified are valid, you can edit a configuration file to
override the winnowing process.

To force the data collection to use all the specified credentials

1 On the server that hosts the UC Analytics Data Engine, navigate to the folder in which the Data Engine
collector role is installed. By default, the Data Engine folder is located at:
C:\Program Files\Quest\UC Analytics\Data Engine
2 Create a backup copy of the UC.Analytics.Insights.DataEngine.DataCollector.dll.config file and save it to a
different location.
3 Using a text editor, open the UC.Analytics.Insights.DataEngine.DataCollector.dll.config file.
4 Locate the following section and find the winnowPowerSheelCredentials setting.
<exchangeOnlineMailboxJobSettings
enabled="true"
powerShellMaxAttempts="3"
powerShellSecondsBetweenAttempts="300"
...
winnowPowerShellCredentials="true"/>
5 Change the value for winnowPowerShellCredentials to "false".
6 Save your change.
7 For the changes to take effect, restart the Data Engine service.

Unified Communications Analytics 8.5 Deployment Guide

141
Appendix E: Custom configurations and backup and recovery options
 F
Appendix F:
Questions and answers about data
source configuration
• How often do the data collections actually gather data and when do they run?
• Why did an insight show no data for a 30-day range though I initially set the data source to collect 30 days
back?
• If I collect both Exchange Tracking Logs and Exchange Mailbox Contents, are there duplicate items?
• If I collect message data only from the Exchange tracking logs, is the message Send Date and delivery
time available?
• What are the differences between the Exchange Mailbox Contents and Exchange Tracking Logs data
sources?
• Why do I get an error when collecting Exchange configuration from multiple Exchange versions?
• Why do I have to specify domain name when doing a multi-forest collection?

Introduction
This section includes common questions and provides detailed answers to help you understand and troubleshoot
your UC Analytics deployment.

How often do the data collections actually

gather data and when do they run?
Does a data collection only collect data once per UTC day? When I set the frequency for how often a collection will
run, does the counter start at midnight (UTC/local) or does it start when the Data Engine service starts?

Answer
All user-created data sources (except for Mailbox Contents) run aligned with UTC midnight and, when you add the
data source and start the Data Engine, at the interval that you specified in the data source. You can set the
execution interval for all data sources except Mailbox Contents. The default interval is different for each data
source, but all are more frequent than once a day.
The Configuration data sources (Exchange/Lync/Cisco/Domain Controllers) and the Exchange Public Folder data
source are unique in that they only collect data once a day (first run in the UTC day). Even if you scheduled these
collections to run more than once a day, they take a “snapshot” of the data only once per UTC day. You might
schedule the data sources to run multiple times per day to handle any situation when data collection fails.
For example, suppose you add an Exchange Configuration data source, schedule it to run every 6 hours, and you
created the data source at 8:00 am UTC. The data source job will run (in UTC) as follows:

Unified Communications Analytics 8.5 Deployment Guide

142
Appendix F: Questions and answers about data source configuration
 • 8:00 am (it runs when scheduled and collects data)
• 12:00 pm (this the next multiple of 6 hours after midnight – no data is collected because it is the second run
of the day)
• 6:00 pm (no data collected)
• 12:00 am (collects data since first run of the day)
• 6:00 am (no data collected)
If an Exchange Configuration data source job is scheduled every 24 hours, and was created at 8:00 a.m. (UTC),
then the data source will run (in UTC) as follows:
• 8:00 a.m.
• 12:00 a.m.
• 12:00 a.m.
If a data source job is still running during its next scheduled execution time, the job execution is skipped.
The Mailbox Contents does not have a scheduled interval nor is it aligned on UTC midnight. The Mailbox Contents
collection job runs continuously, with a minimum interval between the job execution start times. The start time is
unpredictable. If the job execution takes less time than the minimum interval, the job will start X minutes (minimum
interval) after the previous job execution started. Otherwise, job execution starts immediately after the previous
execution completes.
For information about when different types of collections will update data in the insights, see How often do
collections update the data? on page 39.

Why did an insight show no data for a 30-day

range though I initially set the data
source to collect 30 days back?
I have just installed UC Analytics. Why does the Lync Organizational Summary User Activity insight show no data
when I use a custom date filter for 4 Jan 2015 - 10 Jan 2015? I set my initial data source collection to go back 30
days and I started it on January 30.

Answer
There are two data source collections that provide information for the Lync Organizational Summary User Activity
insight:
• Domain Controller (AD)
• Lync Configuration
When you started your Domain Controller data collection on Jan 30, the initial data collection period was set to 30
days (default). The Domain Controller data source collects information from AD and retroactively creates AD user
“snapshots” in the database for each user. This ensures that there is a user object to link to historical data from
data sources that collect historical information such as the Exchange Tracking Logs, Lync Users, and so on.
The Lync Configuration data source collection, however, collects data using PowerShell and only creates objects
for the current day. The data only covers the date on which the Lync Configuration data collection accessed
PowerShell to gather the data.
Therefore, on Jan 30, after the data source collections had finished, you had 30 days of AD user data and but only
one day of Lync configuration data (Jan 30). The AD user snapshots from Jan 30 are linked to the Lync
information, but user snapshots from Jan 29, 28, and earlier are not linked since Lync configuration data does not
exist in the database for those dates.

Unified Communications Analytics 8.5 Deployment Guide

143
Appendix F: Questions and answers about data source configuration
The Lync Organizational Summary User Activity insight queries the AD users that are Lync-enabled (users that
have a link to collected Lync data). When you specify “today”, the time range that the query looks for is “from
midnight today until midnight tomorrow”.
When you specify an explicit date range such as Jan 1 - Jan 10, the query looks for the AD user snapshots that
have links to Lync data from Jan 1 until end of Jan 10 (midnight of Jan 11) and takes the latest snapshot from this
period, which is the Jan 10 snapshot. If you apply the rule about how UC Analytics collects historical data to the
specified date range - the only linked AD-Lync data exists for Jan 30, not for Jan 10. For this reason, the insight
shows no data.
After you have had UC Analytics running for a few months, you will have a few months of Lync configuration data
accumulated and can use filters to view historical data in the Lync Organizational Summary User Activity insight.
This same scenario applies to other insights that use either the Lync Configuration or the Exchange Configuration
data source collection to provide information such as:
• Lync User Adoption
• Lync Archiving Policies - Inventory
• Mailboxes - Inventory
• Mailboxes - Permissions inventory
• Mailboxes – Inactive
Since the Lync Configuration or the Exchange Configuration data source collections only gather data for the
current day, even though the Domain Controller (AD) data source collection initially contained 30 days of historical
user data, there would be only one day of data for the linked AD user - Lync/Exchange configuration data.
Over time, as you run the Lync Configuration and the Exchange Configuration data source collections on an
ongoing basis, you would gradually have more days available of linked user Lync/Exchange configuration data.
You can then use custom date range filters on the insights.

If I collect both Exchange Tracking Logs and

Exchange Mailbox Contents, are there
duplicate items?
I have configured both of the following data source collections:
• Exchange Tracking Logs
• Exchange Mailbox Contents (all mailboxes)
You can see information for the same mailboxes in the Exchange Tracking Logs data collection and in the
Exchange Mailbox Contents data collection. If you run both data source collections, are there duplicate items in
the UC Analytics Exchange insights?

Answer
No. The Tracking Log and Mailbox Contents data collections both collect email messages from Exchange
mailboxes. However, if you collect the same messages using both types of data collections the message objects
are not duplicated.
Determining which data collections you want to run is dependent on the information that you want to get from the
messages. If you want a faster data collection, or if you need DLP / journaling messages, set up an Exchange
Tracking Logs data collection. If you want information about response time or email attachments, and are willing to
wait longer for the data collection, set up the Exchange Mailbox Contents data collection.

Unified Communications Analytics 8.5 Deployment Guide

144
Appendix F: Questions and answers about data source configuration
If I collect message data only from the
Exchange tracking logs, is the message
Send Date and delivery time available?
If you are running only the Exchange Tracking Logs data collection but not the Exchange Mailbox Contents data
collection, the insights will contain the Send Date and delivery time for both MAPI and SMTP submitted messages.
However, in some special circumstances, there are a couple of limitations:
• If an SMTP message is both undeliverable and has no internal Exchange server hops, the Send Date is
unavailable and no delivery time is calculated.
• For MAPI and SMTP messages with at least one recipient in a moderated distribution group, the displayed
Send Date can be the date when the message was approved by the moderator (and delivery was resumed
to the group recipients) instead of the date when the message was originally sent. The delivery time is
calculated from the time the message resumed its transit. When this occurs, for any recipients who had the
message delivered directly to their mailbox before the moderator approved it, a received time can display
that is before the Send Date.
If you are also running Exchange Mailbox Contents data collection, the Send Date is always obtained from the
Date field of the message.

What are the differences between the Exchange

Mailbox Contents and Exchange Tracking Logs
data sources?
Both the Exchange Mailbox contents and the Exchange Tracking Logs data sources can be configured to collect
Exchange messages. What are the differences in the information that the two data collections gather?

Answer
The following table shows the differences in email message statistics between the two data sources that collect
Exchange email message information:
• Exchange Mailbox Content (EWS) data source
• Exchange Tracking Log data source

Table 41. How Exchange message data is collected by different UC Analytics data sources.

Exchange Mailbox Content (EWS) Exchange Tracking Log

What gets collected
data source data source
Exchange user messages from You select Exchange target mailboxes by You specify the target tracking log
the specified data source specifying groups (distribution groups or folders on your Exchange servers.
targets security groups) or individual users. Only the messages that transferred
Only the messages from selected through the specified servers are
mailboxes are collected. collected.
Message history Only the messages within the “deleted Only the messages that fall within the
Collection of message history is mailbox retention period” are collected. tracking log maximum age
limited by By default, a 30 day maximum message (MessageTrackingLogMaxAge) as
history is set in the data collection set in the Exchange server
• data retention time
configure file. To collect more history, you configuration are collected.
• start date specified for
must manually update the configuration
the data collection.
file.

Unified Communications Analytics 8.5 Deployment Guide

145
Appendix F: Questions and answers about data source configuration
Table 41. How Exchange message data is collected by different UC Analytics data sources.

Exchange Mailbox Content (EWS) Exchange Tracking Log

What gets collected
data source data source
System messages include: Are not collected. Are collected and are marked as
• legacy public folder “system messages”.
synchronization
messages
• health mailbox testing
messages
• system attendant
messages
• system monitoring
messages
Journaling messages Are not collected unless the journaling Are collected and are marked as
mailbox is configured as a data source Journaling messages.
target. In this case, the messages are not
marked as journaling messages.
SMTP messages Are collected if they are sent to one of Are collected, but the “message sent
the target mailboxes. time” for inbound messages is
Are not collected if they are sent to non- approximate. Delivery time is set only
target mailboxes or to external recipients. after the Exchange Calculation job
has run.
Messages from outside Will be collected if they are sent to one of Will be collected, but the “message
organizations the configured target mailboxes. sent time” inbound messages is
approximate. Delivery time is set only
after the Exchange Calculation job
has run.
Messages sent to outside Are collected if they are sent from one of Are collected. The “message receive
organizations the target mailboxes. The “message time” and “message delivery time”
receive time” and “message delivery are not set.
time” are not set.
Missing message properties None Importance
Sensitivity
Encryption
Conversation
Body
Response Time
Missing message participant None Sender On Behalf Of
properties NOTE: If a message is collected through To, CC,BCC (shows message
EWS and the message was sent from a recipients but not whether the To,
mailbox user to a distribution group to CC, or BCC box was used)
which the user belongs, the user is
counted only as a sender, not a recipient. Sent Time Of Day
If the tracking log collection was also run, Was Sent After Hours
that user is also counted as a recipient.
Was Received After Hour
In Reply To
Message size Message size in mailbox. The size in Message size in transport. The
sender’s mailbox takes precedence. earliest transport size takes
precedence.

Unified Communications Analytics 8.5 Deployment Guide

146
Appendix F: Questions and answers about data source configuration
Why do I get an error when collecting Exchange
configuration from multiple Exchange
versions?
I am collecting from Exchange 2010, and Exchange 2016 and Office 365 hybrid. For the Exchange configuration
data source collection, I get the following message with job type Exchange Configuration for the mailboxes that are
stored in Office 365:
“Unable to detect the Exchange Mailbox version or Exchange configuration data source does not support
the target mailbox version.”
I’ve verified that Impersonation is granted in Office 365, and I checked the PowerShell connection parameters.
Why I am getting this message?

Answer
You must create separate Exchange configuration data collections for Exchange 2010 on-premise and for
Exchange 2016/ Office 365 hybrid.
If you only added an Exchange configuration data source for Exchange 2016, you will see that the Exchange
2010/2013 option is greyed out so it is not being used. Create another Exchange configuration data collection for
Exchange 2016 and that will collect the mailboxes from Exchange 2016 and Office 365 hybrid as well.
Also in the Exchange 2010 Exchange configuration data source, remove the server name that you added under
Exchange 2016.
After you have configured multiple Exchange configuration data sources, you can use the Rename option to
uniquely identify each data collection. For information about how rename a data source, see Renaming a data
source on page 43.

Why do I have to specify domain name when

doing a multi-forest collection?
During a multi-forest collection for the Exchange configuration data source, the Common Name or Email Address
would not work when specifying the Target Mailboxes for the collection. We had to put in DomainName\User or
DomainName\Group
The domain name is the netbios name of the other forest from which I was collecting.

Answer
The key to making the multi-forest configurations work is you cannot use the “Automatically discover domain
controller” for data sources in the secondary forests. This setting is selected by default and is hidden. To access
the setting, you must click the Show Advanced Settings link in the LDAP Connection Parameters section. Specify
a specific domain controller.

Unified Communications Analytics 8.5 Deployment Guide

147
Appendix F: Questions and answers about data source configuration
 About us

We are more than just a name

We are on a quest to make your information technology work harder for you. That is why we build community-
driven software solutions that help you spend less time on IT administration and more time on business innovation.
We help you modernize your data center, get you to the cloud quicker and provide the expertise, security and
accessibility you need to grow your data-driven business. Combined with Quest’s invitation to the global
community to be a part of its innovation, and our firm commitment to ensuring customer satisfaction, we continue
to deliver solutions that have a real impact on our customers today and leave a legacy we are proud of. We are
challenging the status quo by transforming into a new software company. And as your partner, we work tirelessly to
make sure your information technology is designed for you and by you. This is our mission, and we are in this
together. Welcome to a new Quest. You are invited to Join the Innovation™.

Our brand, our vision. Together.

Our logo reflects our story: innovation, community and support. An important part of this story begins with the letter
Q. It is a perfect circle, representing our commitment to technological precision and strength. The space in the Q
itself symbolizes our need to add the missing piece — you — to the community, to the new Quest.

Contacting Quest
For sales or other inquiries, visit www.quest.com/contact.

Technical support resources

Technical support is available to Quest customers with a valid maintenance contract and customers who have trial
versions. You can access the Quest Support Portal at https://support.quest.com.
The Support Portal provides self-help tools you can use to solve problems quickly and independently, 24 hours a
day, 365 days a year. The Support Portal enables you to:
• Submit and manage a Service Request.
• View Knowledge Base articles.
• Sign up for product notifications.
• Download software and technical documentation.
• View how-to-videos.
• Engage in community discussions.
• Chat with support engineers online.
• View services to assist you with your product.

Unified Communications Analytics 8.5 Deployment Guide

148
About us
Unified Communications Analytics 8.5 Deployment Guide
149
About us