Chat now with support
Chat with Support

Unified Communications Analytics 8.7 - Deployment Guide

Prerequisites for your installation Installing UC Analytics Configuring UC Analytics Adding data sources for Active Directory or Azure Active Directory 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 Creating an Exchange Tracking Logs data source Creating an Exchange Mailbox Contents data source 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 Adding Exchange Online data sources for native Office 365 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 Adding data sources, chargeback, and thresholds for Cisco Managing which insights can seen by users Configuring and managing subscriptions Making changes to your deployment Appendix A:Configuring Exchange and Office 365 Appendix B:Configuring the Skype for Business or Lync Server Appendix C:Configuring IIS Log Files to capture ActiveSync or OWA events Appendix D:PowerShell cmdlets used by data sources Appendix E:Backup and recovery options Appendix F:Custom configurations Appendix G: Questions and answers about UC Analytics

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
1
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.
2
Locate the exchangeTrackingLogJobSetting section (line 230):
<exchangeTrackingLogJobSettings
enabled="true"
induceGarbageCollections="false"
primaryCollectorOnly="false"
initialDataCollectionDays="30"
3
Enter a new value for initialDataCollectionDays. The default value is 30.
4
Restart the UC Analytics Data Engine service.
To modify initial collection days for IIS logs
1
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.
2
Locate the exchangeIisLogJobSettings section (line 246):
<exchangeIisLogJobSettings
enabled="true"
primaryCollectorOnly="false"
initialDataCollectionDays="30"
3
Enter a new value for initialDataCollectionDays. The default value is 30.
4
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.

1
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.
2
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"
3
Enter a new value for initialDataCollectionDays. The default value is 30.
4
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 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
1
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.
2
Locate the <insightRenderingConfiguration> section and the following parameters:
<add name="exportHeaderForRawTsvOrCsv" value="false"/>
<add name="exportHeaderForFormattedTsvOrCsv" value="true"/>
<add name="exportViewTitleForRawTsvOrCsv" value="false"/>
<add name="exportViewTitleForFormattedTsvOrCsv" value="true"/>
<add name="exportCustomizedUnitsForRawTsvOrCsv" value="false"/>
<add name="exportCustomizedUnitsForFormattedTsvOrCsv" value="true"/>
<add name="exportDisplayValueOfBoolean" value="yes,no"/>
3
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:
<add name="exportHeaderForFormattedTsvOrCsv" value="false"/>
4
Save the changed file and restart Data Engine service.

Excluding insight date range and filters from subscription emails

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
1
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.
2
Locate the <insightRenderingConfiguration> section and the following parameters:
<add name="subscriptionEmailSubjectIncludeDateRange" value="true"/>
<add name="subscriptionEmailBodyIncludeDateRangeAndFilters" value="true"/>
3
To remove the information from the email subject or body, change value = true to value = false for the corresponding parameter.
4
Save the changed file and restart Data Engine service.

Changing the PowerShell wait time after transient errors

When the PowerShell exception "An error caused a change in the current set of domain controllers" occurred in the following data source collections, UC Analytics would wait for 300 seconds before retrying. Now it will create a new session and retry immediately (by default).

•
Exchange Online Native/Hybrid Mailbox Configuration
•
Exchange Online Native/Hybrid User Configuration
•
Exchange Online Mailbox Contents
•
Exchange Online Public Folders
•
Office 365 User Subscription Configuration

If you want to customize the PowerShell wait time, you can edit the value for each data source.in the UC.Analytics.Insights.DataEngine.DataCollector.dll.config file.

To modify default wait time for PowerShell connection
1
Using a text editor, open the UC.Analytics.Insights.DataEngine.DataCollector.dll.config file.
By default, the file is located in C:\Program Files\Quest\UC Analytics\Data Engine.
2
Locate the following section and parameters:
<exchangeOnlineMailboxContentsJobSettings
powerShellSecondsAfterTransientServerProblem="0"
<exchangeOnlineUserJobSettings
powerShellSecondsAfterTransientServerProblem="0"
<office365UserSubscriptionJobSettings
powerShellSecondsAfterTransientServerProblem="0"
<exchangeOnlineMailboxJobSettings
powerShellSecondsAfterTransientServerProblem="0"
<exchangeOnlinePublicFoldersJobSettings
powerShellSecondsAfterTransientServerProblem="0"
3
After powerShellSecondsAfterTransientServerProblem, enter a new value for the number of seconds that UC Analytics should wait before retrying PowerShell
4
Restart the UC Analytics Data Engine service.
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating