Connect to Microsoft Dataverse Data in RapidMiner

This article shows how you can easily integrate the CData JDBC driver for Microsoft Dataverse into your processes in RapidMiner. This article uses the CData JDBC Driver for Microsoft Dataverse to transfer Microsoft Dataverse data to a process in RapidMiner.

Connect to Microsoft Dataverse in RapidMiner as a JDBC Data Source

You can follow the procedure below to establish a JDBC connection to Microsoft Dataverse:

1. Add a new database driver for Microsoft Dataverse: Click Connections -> Manage Database Drivers.
2. In the resulting wizard, click the Add button and enter a name for the connection.
3. Enter the prefix for the JDBC URL: jdbc:cds:
4. Enter the path to the cdata.jdbc.cds.jar file, located in the lib subfolder of the installation directory.
5. Enter the driver class: cdata.jdbc.cds.CDSDriver
6. Create a new Microsoft Dataverse connection: Click Connections -> Manage Database Connections.
7. Enter a name for your connection.
8. For Database System, select the Microsoft Dataverse driver you configured previously.
9. Enter your connection string in the Host box.

   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.

   A typical connection string is below:

   OrganizationUrl=https://myaccount.crm.dynamics.com/InitiateOAuth=GETANDREFRESH
10. Enter your username and password if necessary.

You can now use your Microsoft Dataverse connection with the various RapidMiner operators in your process. To retrieve Microsoft Dataverse data, drag the Retrieve operator from the Operators view. With the Retrieve operator selected, you can then define which table to retrieve in the Parameters view by clicking the folder icon next to the "repository entry." In the resulting Repository Browser, you can expand your connection node to select the desired example set.

Finally, wire the output to the Retrieve process to a result, and run the process to see the Microsoft Dataverse data.