Chat now with support
Chat with Support

Unified Communications Analytics 8.8.3 - 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

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"
powerShellIdleTimeout="60"
powerShellOpenTimeout="60"
powerShellOperationTimeout="60"
<exchangeOnlineUserJobSettings
powerShellSecondsAfterTransientServerProblem="0"
powerShellIdleTimeout="60"
powerShellOpenTimeout="60"
powerShellOperationTimeout="60"
<office365UserSubscriptionJobSettings
powerShellSecondsAfterTransientServerProblem="0"
powerShellIdleTimeout="60"
powerShellOpenTimeout="60"
powerShellOperationTimeout="60"
<exchangeOnlineMailboxJobSettings
powerShellSecondsAfterTransientServerProblem="0"
powerShellIdleTimeout="60"
powerShellOpenTimeout="60"
powerShellOperationTimeout="60"
<exchangeOnlinePublicFoldersJobSettings
powerShellSecondsAfterTransientServerProblem="0"
powerShellIdleTimeout="60"
powerShellOpenTimeout="60"
powerShellOperationTimeout="60"
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.

Changing the PowerShell reconnect interval for Exchange Online Mailbox Configuration jobs

To prevent Office 365 throttling in the Exchange Online (Native / Hybrid) Mailbox Configuration data collections when using the same credential, UC Analytics disconnects the PowerShell connection after each round in the job. To prevent the job from running too slowly over time, UC Analytics reconnects the PowerShell session periodically. By default, the reconnection interval time is 60 minutes. If the connection is currently in use, it is disconnected only after the current batch of mailboxes (in which the connection is being used) is completed.

You can change the time interval that is used for the PowerShell reconnection by editing the UC.Analytics.Insights.DataEngine.DataCollector.dll.config file. If you set the reconnection time to 0, UC Analytics will not re-establish the PowerShell session.

To modify the PowerShell reconnection time
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:
<exchangeOnlineMailboxJobSettings
powerShellTimeoutMinutes="30"
powerShellBatchSize="50"
powerShellConnectionReestablishMinutes="60"
3
After powerShellConnectionReestablishMinutes, enter a new value for the number of minutes that UC Analytics should wait before re-establishing the PowerShell session.
4
Restart the UC Analytics Data Engine service.

Modifying timeout values for EWS collection jobs

By default, the Microsoft Exchange EWS (Exchange Web Services) API sets a timeout property value of 100000 ms (100 seconds) as the default. For Office 365 data collections, this timeout value may not long enough for a data source to collect data.

Parameters in the UC.Analytics.Insights.DataEngine.DataCollector.dll.config file are used to set different timeout defaults for Exchange and Exchange Online EWS data collections to provide flexible timeout configuration and to reduce data source collection timeouts.

The default value "ewsTimoutSeconds = 100" is used for on-premises EWS job settings:

exchangeWebServicesJobSettings
exchangeMailboxContentSummaryJobSettings
exchangeCalendarJobSettings

The default value “ewsTimoutSeconds= 1800" is used for online EWS job settings:

exchangeOnlineMailboxContentsJobSettings

Data sources that are affected by the EWS timeout setting are as follows:

•
Exchange Mailbox Contents
•
Exchange Online Mailbox Contents
•
Exchange Mailbox Content Summary
•
Exchange Online Mailbox Content Summary
•
Exchange Calendar
•
Exchange Online Calendar
To modify the default timeout for online EWS collection jobs
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 parameter:
exchangeOnlineMailboxContentsJobSettings = 1800
3
Enter a new value for the number of seconds for the EWS timeout.
4
Restart the UC Analytics Data Engine service.

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 41. 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
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.
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating