Feed Microsoft Dataverse Data into FineReport

The CData JDBC Driver for Microsoft Dataverse fully implements the JDBC standard and can provide Microsoft Dataverse data connectivity to a wide variety of BI, reporting, and ETL tools and custom applications. In this article, we explain how to set Microsoft Dataverse data as JDBC data source in FineReport and view Microsoft Dataverse data as a table in the Report Designer.

Set Up a JDBC Data Source of Microsoft Dataverse Data

Follow the instruction below to set Microsoft Dataverse data as a FineReport database connection.

1. Copy the cdata.jdbc.cds.jar file from the lib folder in the CData JDBC Driver for Microsoft Dataverse installation directory to the lib folder of the FineReport installation directory. You will need to copy the cdata.jdbc.cds.lic file as well.
2. From the Server tab, select Define Data Connection, click to add a new connection, and click JDBC.

Next we will set up the data connection definition in the window.

1. Database: Others
2. JDBC Driver: cdata.jdbc.cds.CDSDriver
3. URL: A standard JDBC connection string using semicolon-separated connection properties.

   You can connect without setting any connection properties for your user credentials. Below are the minimum connection properties required to connect.

   • InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
   • OrganizationUrl: Set this to the organization URL you are connecting to, such as https://myorganization.crm.dynamics.com.
   • Tenant (optional): Set this if you wish to authenticate to a different tenant than your default. This is required to work with an organization not on your default Tenant.

   When you connect the Common Data Service OAuth endpoint opens in your default browser. Log in and grant permissions. The OAuth process completes automatically.

   Built-in Connection String Designer

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

   java -jar cdata.jdbc.cds.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.

   A typical JDBC URL is below:

   jdbc:cds:OrganizationUrl=https://myaccount.crm.dynamics.com/
4. Click Connection pool attributes and set Test before getting connections to No.

Click Test connection to ensure you have configured the connection properly. With the connection to Microsoft Dataverse set up, you can use it as FineReport data source.

Select Microsoft Dataverse Data in the Report Designer.

1. Click to add a new template data set and select DB query to open the database query window.
2. Choose the JDBC connection that you created from the dropdown list.
3. The Microsoft Dataverse entities will appear as tables on the left pane.
4. Write a SELECT statement for the Microsoft Dataverse data tables and columns that you want to load.
5. Click preview and data is shown as table.

With these simple steps, Microsoft Dataverse can be used as a JDBC data source in FineReport.