Manage Microsoft Dataverse Data in DBArtisan as a JDBC Source

The CData JDBC Driver for Microsoft Dataverse seamlessly integrates Microsoft Dataverse data into database management tools like DBArtisan by enabling you to access Microsoft Dataverse data as a database. This article shows how to create a JDBC source for Microsoft Dataverse in DBArtisan. You can then edit data visually and execute standard SQL.

Integrate Microsoft Dataverse Data into DBArtisan Projects

Follow the steps below to register Microsoft Dataverse data as a database instance in your project:

1. In DBArtisan, click Data Source -> Register Datasource.
2. Select Generic JDBC.
3. Click Manage.
4. In the resulting dialog, click New. Enter a name for the driver and click Add. In the resulting dialog, navigate to the driver JAR. The driver JAR is located in the lib subfolder of the installation directory.
5. In the Connection URL box, enter credentials and other required connection properties in the JDBC URL.

   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.

   Below is a typical connection string:

   jdbc:cds:OrganizationUrl=https://myaccount.crm.dynamics.com/InitiateOAuth=GETANDREFRESH
6. Finish the wizard to connect to Microsoft Dataverse data. Microsoft Dataverse entities are displayed in the Datasource Explorer.

You can now work with Microsoft Dataverse data as you work with any other database. See the driver help documentation for more information on the queries supported by the Microsoft Dataverse API.