Unified Communications Analytics 8.8.2

Chat now with support

Get Live Help
Complete Registration

Sign In

Request Pricing

Contact Sales

Table of Contents

Prerequisites for your installation

Overview Supported environments

Supported browsers

Architecture

Information stored by the Storage Engine

Deployment options Hardware minimum requirements

Suggested hardware configurations for different size environments

Software prerequisites

Prerequisites for the UC Analytics services Web site prerequisites

Firewall configuration: ports for data collection Planning for deployment Determining where to install services What files need to communicate through software firewalls? What files should be excluded from anti-virus software? About UC Analytics configuration

Installing UC Analytics

Types of installations

Upgrading from 8.1 or later

Considerations before you install

About a pilot installation About a production installation

Accounts used during installation Performing a pilot installation Performing a production installation

Installing a second Storage Engine after installation Installing additional collector roles

Activating the UC Analytics license Setting up the web site for HTTPS

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

Entering multiple values in a field Recommendations for collecting from Office 365

How often do collections update the data? Viewing the collection job status Forcing a data source collection to run now Renaming a data source

When would I use the Delete Data option?

Managing data sources through batch operations Managing credentials used by multiple data sources Identifying your internal domains Classifying domains for message traffic Setting where data calculation for insights is performed Excluding <none> values from insights Excluding today's data in insights Setting time zone usage for all users Granting full access to Admin Settings Granting users access to data Setting working hours for rooms Accessing the UC Analytics web site

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, chargeback costs, and thresholds for Exchange and Exchange Online

Permissions needed to collect Exchange on-premises or hybrid data

Permissions needed to collect from native Exchange Online Creating an Exchange Configuration data source

Best practices for gathering performance Using dynamic distribution groups to select target mailboxes What types of mailboxes are excluded? Can I enter the Domain Users group as the target for the data collection? Troubleshooting the Exchange configuration collection

Creating an Exchange Tracking Logs data source Creating an Exchange Mailbox Contents data source

Tips for better performance for mailbox contents collection

Do I need both Exchange Tracking Logs and Exchange Mailbox Contents collections? Creating an Exchange IIS Logs data source Creating an Exchange Mailbox Content Summary data source Creating an Exchange Calendar data source Creating an Exchange Public Folders data source Adding Exchange Online hybrid data sources for hybrid Office 365

About AD synchronization methods for hybrid Exchange Online About PowerShell collection method options Creating an Exchange Online Hybrid User Configuration data source Creating an Exchange Online Hybrid Mailbox Configuration data source

Adding Exchange Online data sources for native Office 365

Creating an Exchange Online Native User Configuration data source Creating an Exchange Online Native Mailbox Configuration data source Creating an Exchange Online Mailbox Contents data source Creating an Exchange Online Mailbox Content Summary data source Creating an Exchange Online Calendar data source Creating an Exchange Online Public Folders data source

Setting chargeback costs for Exchange Setting thresholds for Exchange metrics Omitting words when filtering by subject or body

Adding data sources, chargeback costs, and thresholds for Skype for Business/Lync

Permissions needed to collect Skype for Business/Lync data

Permissions needed for Skype for Business/Lync configuration data source Permissions needed for Skype for Business/Lync CDR data source Permissions needed for Skype for Business/Lync QoE data source

Creating a data source for Skype for Business/Lync configuration Creating a data source for Skype for Business/Lync CDR Database Creating a data source for Skype for Business/Lync QoE Database Setting call classifications for Skype for Business/Lync Setting chargeback costs for Skype for Business/Lync Setting thresholds for Skype for Business/Lync metrics

Adding new threshold classifications

Adding data sources, chargeback, and thresholds for Cisco

Permissions needed to collect Cisco data

Permissions needed for the Cisco configuration data source Permissions needed for the Cisco CDR logs data source

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

Managing which insights can seen by users

Enabling a Company Home Page Setting insight visibility settings

Configuring and managing subscriptions

What are insight subscriptions? Configuring settings for subscriptions Managing user subscriptions

Making changes to your deployment

Options available in the Deployment Manager Changing the service account Deploying a second Storage Engine Deploying additional collectors Using the Tools menu for support activities

Appendix A:Configuring Exchange and Office 365

Overview Setting impersonation for Exchange 2013/2016/2019 Configuring impersonation for Office 365 Registering UC Analytics with the Microsoft Azure portal Installing the Exchange Online PowerShell module Setting up a multi-forest environment with a one-way trust

Appendix B:Configuring the Skype for Business or Lync Server

Configuring Lync Server 2010

1. Adding the SQL store for monitoring 2. Installing the Monitoring role 3. Enabling Call Detail Recording (CDR) 4. Starting the monitoring services

Configuring Lync Server 2013 or Skype for Business 2015/2019

1. Associating the store with the Front-End pool 2. Updating the Lync or Skype for Business Server 3. Enabling and configuring monitoring 4. Starting the monitoring services

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?

Appendix D:PowerShell cmdlets used by data sources

Exchange Configuration data source Exchange and Exchange Online Public Folders data sources 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

Appendix E:Backup and recovery options

Backing up and restoring your data using scripts

Supported scenarios About the backup and restore batch files

Prerequisites

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

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

Appendix F:Custom configurations

Setting LDAP connections to use LDAPS (LDAP over SSL) Modifying the Data Query Availability job run Modifying collection days for data collections from log files Changing initial collection days for Exchange (Online) Mailbox Contents data sources Changing default values for formatted .csv or .tsv file exports Excluding insight date range and filters from subscription emails Changing the PowerShell wait time after transient errors Changing the PowerShell reconnect interval for Exchange Online Mailbox Configuration jobs Modifying timeout values for EWS collection jobs 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 Registry settings that affect service shutdown and startup

Appendix G: Questions and answers about UC Analytics

Introduction

How often do the data collections actually gather data and when do they run? When I view insights that show internal vs. external traffic, there is no data for internal traffic. Why? Why are my OWA insights not showing any data? 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 andExchange 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 ExchangeMailbox Contents and Exchange Tracking Logs data sources? Why do I get an error when collecting Exchangeconfiguration from multiple Exchange versions? Why do I have to specify domain name when doing a multi-forest collection? What insights are affected by the "Calculate insight data on server side" option?

Modifying collection days for data collections from log files

In some circumstances, you might create a new data source to collect from log files (IIS logs, Exchange tracking logs, Skype for Business/Lync CDR and QOE logs) that have already been collected. If you have a large retention period, such as 365 days, you might want to limit the amount of data that the new data source collects.

In this case, you can set a configuration option to restrict the initial collection time period for the specific data sources that collect from log files (Exchange Tracking Logs, IIS Logs, Skype for Business / Lync CDR Database, and Skype for Business / Lync QoE Database). You set the configuration option in the UC.Analytics.Insights.DataEngine.DataCollector.dll.config file.

To modify initial collection days for Exchange tracking Logs

Using a text editor, open the UC.Analytics.Insights.DataEngine.DataCollector.dll.config file. The file is located in C:\Program Files\Quest\UC Analytics\Data Engine.

Locate the exchangeTrackingLogJobSetting section (line 230):

<exchangeTrackingLogJobSettings

enabled="true"

induceGarbageCollections="false"

primaryCollectorOnly="false"

initialDataCollectionDays="30"

Enter a new value for initialDataCollectionDays. The default value is 30.

Restart the UC Analytics Data Engine service.

To modify initial collection days for IIS logs

Using a text editor, open the UC.Analytics.Insights.DataEngine.DataCollector.dll.config file. The file is located in C:\Program Files\Quest\UC Analytics\Data Engine.

Locate the exchangeIisLogJobSettings section (line 246):

<exchangeIisLogJobSettings

enabled="true"

primaryCollectorOnly="false"

initialDataCollectionDays="30"

Enter a new value for initialDataCollectionDays. The default value is 30.

Restart the UC Analytics Data Engine service.

To modify initial collection days for CDR or QOE logs

You can modify the collection days for the Skype for Business / Lync CDR Database and Skype for Business / Lync QoE Database data sources.

Using a text editor, open the UC.Analytics.Insights.DataEngine.DataCollector.dll.config file. The file is located in C:\Program Files\Quest\UC Analytics\Data Engine.

Locate the lyncCdrDatabaseJobSettings section or the lyncQoeDatabaseJobSettings section, depending on the collection that you want to change.

<lyncCdrDatabaseJobSettings

enabled="true"

induceGarbageCollections="false"

primaryCollectorOnly="false"

initialDataCollectionDays="30"

AND/OR

<lyncQoeDatabaseJobSettings

enabled="true"

induceGarbageCollections="false"

primaryCollectorOnly="false"

initialDataCollectionDays="30"

Enter a new value for initialDataCollectionDays. The default value is 30.

Restart the UC Analytics Data Engine service.

How the setting works

When the collection job enumerates the files within the tracking log or IIS log folders, it retrieves the file date from the log file name (such as MSGTRK2019070413-1.LOG). The job compares the file date with the following job values:

•

retention date

•

start date of the job

If the file date is newer than both the retention date and start of job date, the collection job continues to process the log file. Otherwise, the log file is skipped. If detailed logging is enabled, the following message is logged in the Data Engine service logs: "Skip tracking log file {0}, because it is too old". Also, if the log entry (date-time) is too old, the collection job skips it.

Changing initial collection days for Exchange (Online) Mailbox Contents data sources

By default, both an initial Exchange Mailbox Contents data collection and an initial Exchange Online Mailbox Contents data collection gather messages for the past 30 days in the target mailboxes.

If the you want to gather older messages in the initial collection, you must update the initialDataCollectionDays setting in sections of the UC.Analytics.Insights.DataEngine.DataCollector.dll.config file and restart Data Engine service. You update the initialDataCollectionDays setting before you create the data sources.

NOTE: If you have created Exchange Mailbox Contents or Exchange Online Mailbox Contents data sources before you updated the initialDataCollectionDays setting, you must disable or delete all the old data sources. After you update the initialDataCollectionDays setting, you create new data sources to bypass the existing checkpoints.

To modify initial collection days for Exchange Mailbox Contents

Using a text editor, open the UC.Analytics.Insights.DataEngine.DataCollector.dll.config file. The file is located in C:\Program Files\Quest\UC Analytics\Data Engine.

Locate the <exchangeWebServicesJobSettings section.

<exchangeWebServicesJobSettings

enabled="true"

induceGarbageCollections="false"

primaryCollectorOnly="false"

enableFastCollection="true"

enableFullCollection="true"

ewsKeepAlive="false"

dataCollectionInsertionThread="1"

initialDataCollectionDays="30"

Enter a new value for initialDataCollectionDays. The default value is 30.

Restart the UC Analytics Data Engine service.

To modify initial collection days for Exchange Online Mailbox Contents

Using a text editor, open the UC.Analytics.Insights.DataEngine.DataCollector.dll.config file. The file is located in C:\Program Files\Quest\UC Analytics\Data Engine.

Locate the <exchangeOnlineMailboxContentsJobSettings section.

<exchangeOnlineMailboxContentsJobSettings

enabled="true"

induceGarbageCollections="false"

primaryCollectorOnly="false"

enableFastCollection="true"

enableFullCollection="true"

ewsKeepAlive="false"

dataCollectionInsertionThread="1"

initialDataCollectionDays="30"

Enter a new value for initialDataCollectionDays. The default value is 30.

Restart the UC Analytics Data Engine service.

Changing default values for formatted .csv or .tsv file exports

When exporting an insight or creating a subscription, in addition to PDF and MHTML output, you can select one several.csv or .tsv file formats:

CSV - Formatted (localized)

CSV - Formatted (UTC)

CSV - Raw

TSV - Formatted (localized)

TSV - Formatted (UTC)

TSV - Raw

By default, the formatted outputs include information such as the insight title, header details such as the insight description, the user who generated the file, date range, filters that were applied to the insight, and date of the export. The formatted output also includes any customized units that were specified in the insight, such as MB instead of KB.

In special cases, you might want to export an insight to formatted .csv or .tsv output but without the title, header information, or custom units.

You can modify the formatted .csv or .tsv file output by editing parameters in the UC.Analytics.Insights.DataEngine.InsightLogic.dll.config file.

To modify default values for exports to formatted .csv or .tsv files

Using a text editor, open the UC.Analytics.Insights.DataEngine.InsightLogic.dll.config file.

By default, the file is located in C:\Program Files\Quest\UC Analytics\Data Engine.

Locate the <insightRenderingConfiguration> section and the following parameters:

To remove the title, header, or custom units for a formatted out, change value = true to value = false for the the corresponding FormattedTsvOrCsv parameter. For example, to remove header information from formatted .csv or .tsv output, you would specify:

Save the changed file and restart Data Engine service.

Excluding insight date range and filters from subscription emails

By default, for a subscription that is sent by email, the email subject contains the insight date range and the body contains both the insight date range and filters that were selected.

In some cases, you might not want this information to be included in the email. You can exclude this information from the email by editing parameters in the UC.Analytics.Insights.DataEngine.InsightLogic.dll.config file.

To exclude date range or filters from subscription emails

Using a text editor, open the UC.Analytics.Insights.DataEngine.InsightLogic.dll.config file.

By default, the file is located in C:\Program Files\Quest\UC Analytics\Data Engine.

Locate the <insightRenderingConfiguration> section and the following parameters:

To remove the information from the email subject or body, change value = true to value = false for the corresponding parameter.

Save the changed file and restart Data Engine service.

Please select your product:

To serve you better, please complete the Purpose of your Chat:

Recommended Solutions for Your Problem

Unified Communications Analytics 8.8.2 - Deployment Guide

Modifying collection days for data collections from log files

Changing initial collection days for Exchange (Online) Mailbox Contents data sources

Changing default values for formatted .csv or .tsv file exports

Excluding insight date range and filters from subscription emails