Chat now with support
Chat with Support

Unified Communications Analytics 8.6.1 - 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 Impersonation 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:Custom configurations and backup and recovery options Appendix F: Questions and answers about configuration

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 35. 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.

You can specify the number of job logs to include in the support package to ensure enough information is provided to Quest Support to analyze and troubleshoot an issue. Specifically, you can include a specified number of:

•
logs per job
•
days (UTC) of logs per job
•
MB of logs per job

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.

Modifying the Data Query Availability job run

The Data Query Availability job (which runs in the background) is split into two parts: one part for the most recent shards and one part for more distant shards. How often each part is run can be configured separately to reduce the number of times the job runs and to create an interim version of a shard while gatherings are still collecting and writing the data for the shard.

By default, both the “most recent” shards (within the last 3 days) and the “more distant” shards (older than 3 days) are still committed every hour.

Using a text editor, you can modify the values for each Data Query Availability job type under the commitJobSettings section in the UC.Analytics.Insights.DataEngine.DataCollector.dll.config file.

The file is located in C:\Program Files\Quest\UC Analytics\Data Engine.

In the commitJobSettings section:

executionFrequencyForRecentShardsInMinutes="60"
executionFrequencyForDistantShardsInMinutes="60"
numberOfShardsBetweenNearEnd="3"
numberOfShardsBetweenFarEnd="-1"

You can modify the job run frequency for each part separately. For example, you might set recent shards to run every 3 hours and more distant shards every 12 hours.

executionFrequencyForRecentShardsInMinutes is the number of minutes between the Data Query Availability job runs to merge "recent shards".
executionFrequencyForDistantShardsInMinutes is the number of minutes between the Data Query Availability job runs to merge "distant shards".
numberOfShardsBetweenNearEnd sets number of shards considered to be "recent shards." A setting of 3 means "recent shards" are the three shards for the most recent three days.
numberOfShardsBetweenFarEnd sets the last shard included in "distant shards." Leave setting at -1 to include all remaining shards not included in "recent shards".

When you view data collection status on the Data Collection Status page, you will see two Data Query Availability jobs which are responsible for committing both recent shards and distant shards.

Modifying collection days for IIS log and Exchange tracking log collections

In some circumstances, you might create a new data source to collect from log files (IIS or Exchange tracking 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 Exchange Tracking Logs data source and/or the IIS Logs data source. 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.
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,
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating