Chat now with support
Chat with Support

Unified Communications Analytics 8.6 - Resource Kit


Only scalar values can be expanded. This means that if you attempt to expand a nested collection or a dynamic field, you get a an error or null values.

To get around the limitation of being unable to expand a nested collection, you could query and download the primary entity and the entity you want to expand. Then you can allow Power BI to autodetect the relationship between the entities using foreign keys.

An example of this workaround is shown in the scenario Using Power BI Desktop to create a graph for specific user email activity .

In this scenario Participants.EmailAddress.Name could not be expanded since EmailAddress is a collection of a collection (Participants). So how do we get EmailAddress.DisplayName? We must also query for the EmailMessageParticipants entity which has the property EmailAddress. Here we can expand and get EmailAddress.DisplayName because DisplayName is a scalar property of EmailAddress.

Using the OData client library

Using the OData client library you can create ad hoc queries using PowerShell or C#. The OData client library complements the bulk data exporter but is slower and is meant to support a smaller amount of data. Unlike the bulk data exporter, you can create queries to get data from calculated fields (such as direction or chargeback amounts) and you can also retrieve aggregated data.

While the bulk data exporter must be run locally, the OData library is secure and can be run remotely.

The OData client library is installed in the Resource Kit folder on the server that hosts the Data Engine. By default, the path is as follows:

In the Resource Kit folder are the .dll files that you must copy to the server from which you want to run your queries.

About the sample files

In the Resource Kit folder there is a folder named Samples that contains examples of both PowerShell and C# queries. For example, the AggregateQuerySamples files for C# and for PowerShell (.cs and .ps1) provide samples that show you how to create queries for aggregated data such as:

To see individual data records, the ObjectQuerySamples files provide a sample query to show a list of the individual inbound messages sent to a specific department.

To get a dump of all the entities and fields that comprise the UC Analytics data model, you can use the DataModelSamples files.

If you have scripts based on sample files that were created before version 8.4.1, ensure that you change instances of Dell.UC. to UC.Analytics. to update them.

You access the OData library using the .NET interface and must be proficient in either PowerShell or C# to write your own queries.

Overview: Using the OData library with PowerShell queries

The OData client library allows you to query the UC Analytics database for information that has been gathered from your target environments. This section describes the main syntax used in the query layer. Though the examples are provided in PowerShell, the information is applicable to C#. Since the syntax is similar, you can extend the examples for C#.

To establish the queries, you must understand PowerShell and be able to read and understand the main PowerShell syntax constructs.

The current OData implementation is a single-view query that answers single-focused questions. The query layer is not a substitute for the more complex types of queries you can do in UC Analytics.

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating