Connect to Microsoft Dataverse Data in NetBeans

The CData JDBC Driver for Microsoft Dataverse integrates connectivity to live Microsoft Dataverse data in IDEs that support JDBC. The JDBC standard enables you to use built-in data access wizards and other tools supporting rapid development. This article shows how to connect to Microsoft Dataverse data in NetBeans. You will create a connection and edit and save Microsoft Dataverse data in the Table Editor.

Create a JDBC Data Source for Microsoft Dataverse in NetBeans

To create the JDBC data source, expand the Database node in the Service window, right-click the Drivers node, and select New Driver. In the New Driver wizard that results, enter the following information:

• Driver File(s): Click Add and, in the file explorer dialog that appears, select the cdata.jdbc.cds.jar file. The driver JAR is located in the lib subfolder of the installation directory.
• Driver Class: Click Find to search for the driver class inside the JAR. Then select cdata.jdbc.cds.CDSDriver from the menu.
• Name: Enter the name for the driver.

Define Connection Parameters

Follow the steps below to define required connection properties:

1. In the Service window, right-click the Database node and click New Connection.

2. In the New Connection Wizard, enter the following connection properties:

   • Driver Name: In the menu, select the CData JDBC Driver for Microsoft Dataverse.
   • User Name: Enter the username. This can also be defined in the JDBC URL.
   • Password: Enter the password. This can also be defined in the JDBC URL.

   • JDBC URL: Specify 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.

     A typical JDBC URL is the following:

     jdbc:cds:OrganizationUrl=https://myaccount.crm.dynamics.com/InitiateOAuth=GETANDREFRESH

Query Microsoft Dataverse Data

To connect to Microsoft Dataverse data, right-click the connection in the Database node and click Connect. After the connection is established, you can expand it to discover schema information.

To load a table in the Data Views window, right-click the table and then click View Data. You can also insert, update, or delete records in the Data Views window.