Introducing Microsoft Call Quality Power BI Connector (aka CQD Power BI Connector)
Published Mar 18 2020 07:25 PM 38.5K Views
Microsoft

For many years, our IT Admins have asked us to enable them to build their own call quality/reliability reports.  We are happy to share that you are now empowered to build your own reports, powered by Advanced Call Quality Dashboard data.

CQD8.png

Download Microsoft Call Quality Power BI Connector

  
Microsoft Call Quality Power BI Connector Installation

The process for installing a custom connector and adjusting security to enable use of the connector is described in detail in the Power BI documentation. For the sake of simplicity though, a quick explanation is provided below:

  1. Check to see if your computer already has a [Documents]\Power BI Desktop\Custom Connectors folder. If not, create this folder.1
  2. Download the connector file (either a *.mez or *.pqx file) and place it in the Custom Connectors directory.
  3. If the connector file is a *.mez file, you will also need to adjust your security settings as described in the custom connector setup documentation.

If a new version of the Microsoft Call Quality Power BI Connector is released, simply replace the old connector file in the Custom Connectors directory with the new file.

 

Microsoft Call Quality Power BI Connector Setup

In order to build a report and run queries, you will first need to connect to the CQD data source. Follow the steps below in order to connect:

  1. In the Home tab of Power BI Desktop, click on Get Data.

CQD1.PNG

  1. The Get Data window should appear at this point. Navigate to Online Services, then select Microsoft Call Quality (Beta) and hit Connect.

CQD2.png

  1. You will be prompted to login next. Use the same credentials that you use for CQD.2
  2. The next prompt will give you the option between two Data Connectivity modes. Select DirectQuery and hit OK.
  3. Finally, you will be given a final prompt showing you the entire data model for CQD. No data will be visible at this point, only the data model for CQD. Select Load to complete the setup process.
  4. At this point, Power BI will load the data model onto the right side of the window. The page will remain otherwise blank, and no queries will be loaded by default. Proceed to Building Queries below in order to build a query and return data.

If any of the steps during this setup process were not completely clear, a more detailed explanation of the process can be found here.

 

Building Queries using Microsoft Call Quality Power BI Connector

Once setup is complete, you should see the names of several hundred dimensions and measures load in the Fields pane. Constructing actual queries from here is simple, just select the dimensions and measures you want for your query, then drag and drop them onto the page. Here’s a more detailed explanation, with a simple example:

  1. Select the visualization you want to use from the Visualizations pane. A blank version of that visualization should appear on the page. For the purposes of this example, we will be using the Table visualization.

CQD3.PNG

  1. Determine which dimensions and measures (denoted by an aggregation symbol by their name) you wish to use for your query, then manually select them and drag them onto the black visualization. Alternately, drag them onto the Values field beneath the visualization options.
 

Important Note: Call Quality Dashboard requires a measure for any query to run. Failure to add a measure to a query will cause that query to fail.

 

  1. Next, select any dimensions you want to filter on and drag them to the Filters on this visual field in the Filters pane. The Microsoft Call Quality Power BI Connector currently supports Basic filtering (select values from a list of possible dimension values), Advanced filtering (manually specify values and operands to filter on, similar to Advanced CQD), and Relative date filtering (only available for the End Time and Start Time dimensions). Filtering according to Top N is not supported by CQD.

CQD5.PNG

  1. Finally, select the Format tab within the Visualizations pane to style and format your query.

 

Note: CQD queries require at least one measure in order to run. If your query does not load, double check that you have included a measure in the query.

 

Creating a Drill-through Report

Drillthrough in Power BI allows you to create focused reports that you can quickly filter using the values of other reports as context. Once you know how to create your first query with the Microsoft Call Quality Power BI Connector, creating a drillthrough is even simpler.

  1. Create another page for the focused report, and then add your queries to that page.
  2. Select the dimension you want to use as a drillthrough filter and drag them onto the Drillthrough field under on the Visualizations pane.

CQD6.PNG

  1. That’s it! Any other query on another page that uses that dimension can now drillthrough to that page, automatically applying the drillthrough dimension’s value as a filter.
    CQD7.PNG

Unlike Advanced CQD, Power BI supports non-sequential drill-through. As long as a query includes the necessary dimension, it can drill-through to any other page.

 

Limitations

Despite making use of Power BI, not all Power BI functionality is support by the Microsoft Call Quality Power BI Connector, either as a result of limitations on CQD data model (such as non existent data) or on DirectQuery connectors in general. The list below notes some of the Connector’s more noteworthy limitations, but this list should not be considered exhaustive:

  1. Calculated Columns – DirectQuery connectors in general have limited support for calculated columns in Power BI. While some calculated columns may work with the Connector, these should be considered exceptions. As a general rule, calculated columns will not function.
  1. Aggregations – The CQD data model is built on a cube model, meaning that aggregations are already supported in the form of measures. Attempting to manually add aggregations to different dimensions or changing the aggregation type of a measure will not work with the Connector, and it will generally result in an error.
  1. Custom Visuals – While the Microsoft Call Quality Power BI Connector does work with a range of custom visuals, we are unable to guarantee compatibility with all custom visuals. Many custom visuals rely on the use of calculated columns or imported data, neither or which are supported by DirectQuery connectors.
  1. Referencing Cached Data – Power BI currently does not support referencing cached data from a DirectQuery connector in any way. Any attempt to reference the results of a query will result in a new query.
  1. Relative Data Filtering – Is supported in the Call Quality Power BI Connector, but only with the Start Time and End Time dimensions. Although the Date dimension may be the obvious choice for relative date filtering, Date is not stored as a date time object and thus does not support relative date filtering in Power BI.

Please note, although the Connector is in preview, these limitations are unlikely to change with the final release of the Connector. Most of these issues are either restrictions to DirectQuery connector design in Power BI or fundamental to the design of the CQD data model.

 

Error Codes

Because the Microsoft Call Quality Power BI Connector is less restricted than the browser app in terms of kinds of queries you can construct, you may occasionally encounter a number of errors while building your queries. In the event that you receive an error message of the type “CQDError. RunQuery – Query Execution Error”, reference the list below with the ErrorType number provided in order to troubleshoot the possible issue with the query. The following are the most common Error Type codes you may encounter with the CQD Power BI Connector:

  • ErrorType 1 - Query Structure Error: A query structure error is typically caused by the Connector failing to build a properly formatted query. This happens most often when using unsupported functionality, as specified in the Limitations above. Double check that you are not using any calculated columns or custom visuals for that query.
  • ErrorType 2 - Query Building Error: A query building error is caused by the Call Quality Power BI Connector being unable to properly parse the query you are attempting to build. This happens most often when using unsupported functionality, as specified in the Limitations above. Double check that you are not using any calculated columns or custom visuals for that query.
  • ErrorType 5 - Execution Timeout: The query has reached the maximum possible runtime before timing out. Try adding more filters to the query in order to limit its scope. Narrowing the data range is often the most effective way to achieve this.
  • ErrorType 7 - No Measurements Error: CQD queries require a measure in order to function. Double check that your query includes measure. Measures in the Call Quality Power BI Connector are denoted by the aggregation (sum) symbol before their name.

If you encounter any additional errors outside of this scope, please notify the CQD team so that we can help troubleshoot the issue and update the documentation as appropriate.

Best practice

Call Quality connector queries should be designed with drillthrough functionality in mind. Instead of trying to load all the data at once, and then slicing down with filters, start with broader, low-cardinality queries and drill down to high-cardinality queries. For instance, when attempting to diagnose which subnets contribute most to quality issues, it's helpful to first identify those regions and countries which contribute to the problem, then drill down to the subnets in that region or country. The Call Quality connector templates have been designed in this manner in order to act as an example.

Other useful best practice links: 

https://docs.microsoft.com/en-us/power-bi/guidance/power-bi-optimization https://docs.microsoft.com/en-us/power-bi/guidance/directquery-model-guidance 

Frequently asked questions

Why does the connector seem slower compared to Advanced CQD in the browser? What can I do to improve performance?

Query performance for the various templates is actually the same in both the browser and in the connector. Just like any other standalone app, Power BI adds its authentication and rendering time to our performance. In addition, the difference comes in the number of concurrent queries being run. Because the in-browser version of CQD had less well-developed and information-dense visualization options, most of our reports were limited to loading 2-3 queries at a time. On the other hand, the connector templates often display 20+ concurrent queries. If you wish to build reports that are just as responsive as the older ones you were used to, try creating reports with no more than 2-3 queries per tab.

 

Footnotes

1 Certain processes and apps (e.g. OneDrive) may cause your Documents root folder to change; make sure that the Power BI Desktop\Custom Connectors directory is placed inside of the current root folder Documents folder.

2 The login credentials you use for CQD do not need to be the same credentials you use for logging into the Power BI Desktop app itself.

 

Copyright 2020 Microsoft Corporation

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

31 Comments
Steel Contributor

Thanks for this detailed explanation

Copper Contributor

Issue: 

- I don't see "Microsoft Call Quality (Beta) and hit Connect" in the Power BI Desktop when navigate to Online Services

 

I'm using the following: 

- Power BI Desktop Version: 2.79.5768.721 64-bit (March 2020)

 

I've created/Done the following: 

 [Documents]\Power BI Desktop\Custom Connectors

- Open Power BI Desktop, select File > Options and settings > Options > Security.

Under Data Extensions, select (Not Recommended) Allow any extension to load without validation or warning. Select OK, and

- Added CQD-Power-BI-query-templates.zip to [Documents]\Power BI Desktop\Custom Connectors and extracted it. 

Microsoft

@GabeGGG If you have installed the connector in your Documents\Power BI Desktop\Custom Connectors folder, and you don't see if when you as an option under "Get Data", there are two likely possibilities:

 

1. You may have simply made a typo in one of the folders you created

2. You have a different root Documents folder. This is common if you have OneDrive installed. Make sure you have the connector installed in the appropriate directory in your root Documents folder.

 

Power BI will always look in the same place for this connector, and if the directory is misnamed or placed in the wrong My Documents/Documents directory, it will not find it.

I have the connector installed, but I'm getting no data at all. Is there something that I need to have turned on to make it available?

Microsoft

did you login with your tenant credential?

I sure did!

Microsoft

@John White You won't get any data when the connector loads. All it receives when it first loads is the data model itself. If you want to see some actual data, try opening one of the templates or create your own query (for example, create a new table and drag Media Type and Total Stream Count onto that table).

Copper Contributor

We have installed the solution and are able to get data for the "Teams Usage" but no data is being returned for the PSTN Call Quality template.  Is there anything needed in our tenant to enable capturing and/or availability of this PSTN data?

Microsoft

Hi Bill,

If you're using the same account to access data in the PSTN report then there shouldn't be anything additional that you need to do, assuming there is data to report. If you do have multiple accounts setup, I'd suggest checking on that first.

Microsoft

@Bill_Orebaugh - in addition to what Jim has written above, we currently only have PSTN Direct Routing data.  If you are using PSTN calling plan or PSTN conferencing, then data will be avail soon (but not now).

cc: @Jim_Coan 

Brass Contributor

Hi Siunie,

 

Which minimum admin role is needed to be able to connect to the Microsoft Call Quality? 

 

I have the screen whith "you are currently signed in" but when I click on connect I get an error message that my credentials have no rights to access.

 

Thanks

 

Alex

Microsoft
Brass Contributor

@Siunie Sutjahjo 

Thank you for your quick answer. One more question. Is it possible to have it on Power BI Online? Didn't find anything about it. Or is it just for the desktop version? Thanks Siunie 

Copper Contributor

Hi,

 

I have a question about one of the Date dimensions : Year

According to the info below, this (Year object) is a dimension

https://docs.microsoft.com/en-us/microsoftteams/dimensions-and-measures-available-in-call-quality-da... 

 

However, it is presented a a Measure (other Date objects do seem to be Dimensions)

The Year object being a Measure and not a Dimension keeps me from creating a (example) totals table based on the Metrics gathered from a Year (I now use the 'Month Year' Dimension, but that gives me multiple Months rows)

 

Am I missing something?

Thx

Henk

 

PBI_Year.bmp

 
 

 

Copper Contributor

Hi,

Does CQD connector works in power BI with import query,

 

Any idea, when this connector will be available for production use.

Thanks

Microsoft

@SushilMaurya7  - Call quality connector is not meant to be used to import data

Copper Contributor

Hi Siunie,

 

Any reaction on my question, Is my assumption correct that the Year object should be a Dimension (see above)

 

thx

Henk

Microsoft

@Alexandre GRANADO 

You can publish the template to Power BI Online from the Desktop Application and make it accessible to other users in your organization in that manner.

https://docs.microsoft.com/en-us/power-bi/service-share-dashboards

https://docs.microsoft.com/en-us/power-bi/service-embed-report-microsoft-teams

Take note of the requirements for publishing so you don't run into issues.

Copper Contributor

Hello, tell me please, is it possible to filter the resulting table using the "Start Date" column by the date range, if so, how? I have already tried all possible options and everywhere I get errors of the form:
  "OLE DB or ODBC error: [Expression.Error] We couldn't fold the expression to the data source. Please try a simpler expression .."
An example of one of the queries:
  "NewTable = FILTER (Query1; Query1 [Start Time]> DATE (2020; 4; 17))"

I really hope for your help, thanks in advance!

Bronze Contributor

About the installation..

 

Was it me only who had the steps 4. 5. in different order. At first PowerBI asked me to load the data, and after that it asked the connectivity method.

4. The next prompt will give you...
5. Finally, you will be given a ...

Where actually in order:

4. Finally, you will be given a final prompt showing you the entire data model for CQD. No data will be visible at this point, only the data model for CQD. Select Load to complete the setup process.
5. The next prompt will give you the option between two Data Connectivity modes. Select DirectQuery and hit OK.

 

Then it started to create connectors etc...

Copper Contributor

Hello Siunie

I'm with a question about 2 information if MS Teams and Power BI integration.
I'm using Microsoft Call Quality connector to extract information about Teams on my company, to use on Power BI.

Every is fine, except to:
1 - I don't find the Meeting Name on table. Just Meeting ID.
2 - I don't find the Meeting Organizer on table.

May you helpme, please?

Copper Contributor

Hello Everyone.

Is there a way to display the Start Time and End Time in Local time and not UTC? It seems I will not be able to use calculated columns because of the limitation of the CQD Power BI Connector.

Copper Contributor

I previously had this installed and it was working fine. I updated Power BI to the latest version (2.83.5894.961) and downloaded the latest CQD connector package. I put the file into my custom connectors folder - I have OneDrive so the folder is remapped but I confirmed I used the correct one.

 

I go through the steps of Get data > Online Services > Microsoft Call Quality (Beta) > Connect

 

This brings up the Microsoft Call Quality table structure and I have the option to Load or Transform Data - I click on Load (but the same problem occurs if I click Transform Data.

 

I select DirectQuery on the next dialog

 

It then displays a couple of Create Connections dialogs and then comes up with an error:

 

Failed to save modifications to the server. Error returned: 'COM error: Microsoft.Data.Mashup, The given data source kind is not supported. Data source kind: MicrosoftCallQuality..

 

How do I resolve this? I need to get back into the CQD reports

 

Copper Contributor

Failed to save modifications to the server. Error returned: 'COM error: Microsoft.Data.Mashup, The given data source kind is not supported. Data source kind: MicrosoftCallQuality..'

 

I am getting the same error...were you ever able to resolve this issue, @AdenG1 

Microsoft
Hi All, I've set up my CDQ dashboards. But I've run into a dataset issue.
 
At first I had this occur- 
 
Cannot load model
Couldn't load the model schema associated with this report. Make sure you have a connection to the server, and try again.
Please try again later or contact support. If you contact support, please provide these details.
 
I reset the dataset - connection and did a manual refresh - but this led to the following error: 
 
Couldn't load the data for this visual
Couldn't retrieve the data for this visual. Please try again later.
Please try again later or contact support. If you contact support, please provide these details.
 
Any suggestions as to why?
Copper Contributor

Thank you!!

Copper Contributor

Will this be made available for GCCH environments?

Microsoft

it is in our roadmap. 

Copper Contributor

Hi - Are you able to access this data via Import method rather than direct query - when i try to switch it across to Import - no data appears in table - is this due to level of data - is there a work around. Our end goal is to get this data out to SQL any suggestions 

Copper Contributor

I am trying to use the Microsoft "Microsoft Call Quality Power BI Connector" and when i am trying to connect i get the error "An unexpected error occurred on send" I need help with the same.

Copper Contributor

Hi All

Where can I find any instructions on using filters in MicrosoftCallQuality.GenerateTable() query (first action in 'transform data' , "= MicrosoftCallQuality.GenerateTable( "MyTenantID",null)") ?
I am trying to build some custom reports and just need some specific data

Thanks

Version history
Last update:
‎Jan 26 2021 12:48 PM
Updated by: