Chat now with support
Chat with Support

Unified Communications Analytics 8.6.1 - Resource Kit

About Metric values

When you run queries against the UC Analytics database, you can provide a specific metric. You can also provide an operation on the metric. The following metric values are supported:

•
Count()
•
CountDistinct()
•
Average(“AttributeName”)
•
Min(“AttributeName”)
•
Max(“AttributeName”)
•
Sum(“AttributeName”)

All metrics are specified in the format: Value(“Fieldname”). The Fieldname uses the same format as the Attribute name in the Where clause. Since fields that require Attribute names are computational, this applies only to numeric fields.

You can specify multiple metric values in a single query. However, the values apply to the grouping that is established for the entire query. The Metric clause applies only to Aggregate queries.

About the Group clause

A common scenario in querying a database is being able to group the results. This part of the query allows you to specify one or more grouping levels.

Each grouping level is a definition of the attribute on which you want to group. The attribute syntax is described in Specifying the Attribute name and value .

Here is an example of a two level group-by:

GroupBy("Recipients.EmailAddress.Person.ObjectType").`
GroupBy("Recipients.EmailAddress.Person.Name").`

The Group clause only applies to Aggregate queries.

About the Trending clause

Trending in this component is a time-based grouping that is sorted. The trending clause uses the following model:

TrendBy("AttributeName", TrendingTimeFrame)

The AttributeName syntax is described in Specifying the Attribute name and value . As this clause is time-based grouping, the attribute specified needs to be a time-based attribute.

The TrendingTimeFrame is a defined variable that must be referenced in your script. The following variables are supported in UC Analytics:

•
$hourly = [UC.Analytics.Insights.ResourceKit.ODataClientLibrary.TrendMode]::Hourly
•
$weekly = [UC.Analytics.Insights.ResourceKit.ODataClientLibrary.TrendMode]::Weekly
•
$monthly = [UC.Analytics.Insights.ResourceKit.ODataClientLibrary.TrendMode]::monthly
•
$quarterly = [UC.Analytics.Insights.ResourceKit.ODataClientLibrary.TrendMode]::Quarterly
•
$yearly = [UC.Analytics.Insights.ResourceKit.ODataClientLibrary.TrendMode]::Annually

You can specify only a single trending clause. The Trending clause applies only to Aggregate queries.

Using the Select clause to return additional information

In many cases, the real information is the number that the query is returning. But sometimes you want additional information as well. This Select clause allows you to specify the additional fields that you want. You provide the list of AttributesNames (using the syntax previously described) in a comma-separated list.

Here is a simple example:

Select("EmailAddress.Person.City", "EmailAddress.Person.Department"), `

The Select clause can be specified only once in a query and is only applicable to Object queries. If you specify the Select clause in an Aggregate query, it will result in an error.

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating