Integrate Miro Data in the Pentaho Report Designer

The CData JDBC driver for Miro data enables access to live data from dashboards and reports. This article shows how to connect to Miro data as a JDBC data source and publish reports based on Miro 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 Miro connection. In the resulting dialog, configure the connection properties as shown below.

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

     Using API Key Authentication

     Miro uses API Key authentication with an access token. To generate an access token:

     1. Log in to your Miro account
     2. Navigate to Settings > Your apps
     3. Click "Create new app" or select an existing app
     4. Configure the required permissions (e.g., boards:read, teams:read)
     5. Install the app and generate an access token
     6. Copy the generated access token (it will only be shown once)

     After obtaining your access token, set the following connection properties:

     • AuthScheme: Set this to APIKey.
     • APIKey: Set this to your access token.

     Connecting to Miro

     Once the authentication is configured, you can connect to Miro and query data from any of the available tables such as Boards, Items, Teams, Organizations, and more.

     Built-in Connection String Designer

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

     java -jar cdata.jdbc.api.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:api:Profile=C:\profiles\Miro.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_access_token';

   • Custom Driver Class Name: Enter cdata.jdbc.api.APIDriver.
   • User Name: The username to authenticate with.
   • Password: The password to authenticate with.
   

Add Miro Data to a Report

You are now ready to create a report with Miro data.

1. Add the Miro 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 ,  FROM Boards WHERE BoardId = '3074457361234567890'

   
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 Boards table.
4. Finally, run the report to see the chart.