Ready to get started?

Learn more about the CData JDBC Driver for Microsoft Teams or download a free trial:

Download Now

Integrate Microsoft Teams Data in the Pentaho Report Designer

Publish reports based on Microsoft Teams data in the Pentaho BI tool.

The CData JDBC Driver for Microsoft Teams data enables access to live data from dashboards and reports. This article shows how to connect to Microsoft Teams data as a JDBC data source and publish reports based on Microsoft Teams data in Pentaho.

Connect and Create a Report

  1. Copy the JAR file of the driver, located in the lib subfolder of the installation directory, to the \Report-Designer\lib\jdbc\ folder in the Pentaho directory.
  2. Run the report-designer.bat file in the \Report-Designer\ folder to open the Report-Designer UI.
  3. Create a new data source with the driver by clicking Data -> Add Data Source -> Advanced -> JDBC (Custom) and then creating a new Microsoft Teams connection. In the resulting dialog, configure the connection properties as shown below.

    • Custom Connection URL property: Enter the JDBC URL. This starts with jdbc:msteams: and is followed by a semicolon-separated list of connection properties.

      You can connect to MS Teams using the embedded OAuth connectivity. When you connect, the MS Teams OAuth endpoint opens in your browser. Log in and grant permissions to complete the OAuth process. See the OAuth section in the online Help documentation for more information on other OAuth authentication flows.

      Built-in Connection String Designer

      For assistance in constructing the JDBC URL, use the connection string designer built into the Microsoft Teams JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

      java -jar cdata.jdbc.msteams.jar

      Fill in the connection properties and copy the connection string to the clipboard.

      When you configure the JDBC URL, you may also want to set the Max Rows connection property. This will limit the number of rows returned, which is especially helpful for improving performance when designing reports and visualizations.

      Below is a typical JDBC URL:

      jdbc:msteams:OAuthClientId=MyApplicationId;OAuthClientSecret=MySecretKey;CallbackURL=http://localhost:33333;InitiateOAuth=GETANDREFRESH
    • Custom Driver Class Name: Enter cdata.jdbc.msteams.MSTeamsDriver.
    • User Name: The username to authenticate with.
    • Password: The password to authenticate with.

Add Microsoft Teams Data to a Report

You are now ready to create a report with Microsoft Teams data.

  1. Add the Microsoft Teams source to your report: Click Data -> Add Data Source -> JDBC and select the data source.

  2. Configure the query. This article uses the one below:

    SELECT subject, location_displayName FROM Teams WHERE Id = 'Jq74mCczmFXk1tC10GB'
  3. Drag a chart onto your report and double-click it to edit the chart. Run the report to display the chart. You can use the results of this query to create a simple chart for the Teams table.
  4. Finally, run the report to see the chart.