Connect to Dynamics 365 Business Central Data in DBeaver

The CData JDBC Driver for Dynamics 365 Business Central implements JDBC standards that enable third-party tools to interoperate, from wizards in IDEs to business intelligence tools. This article shows how to connect to Dynamics 365 Business Central data with wizards in DBeaver and browse data in the DBeaver GUI.

Create a JDBC Data Source for Dynamics 365 Business Central Data

Follow the steps below to load the driver JAR in DBeaver.

1. Open the DBeaver application and, in the Databases menu, select the Driver Manager option. Click New to open the Create New Driver form.
2. In the Driver Name box, enter a user-friendly name for the driver.
3. To add the .jar, click Add File.
4. In the create new driver dialog that appears, select the cdata.jdbc.d365businesscentral.jar file, located in the lib subfolder of the installation directory.
5. Click the Find Class button and select the D365BusinessCentralDriver class from the results. This will automatically fill the Class Name field at the top of the form. The class name for the driver is cdata.jdbc.d365businesscentral.D365BusinessCentralDriver.
6. Add jdbc:d365businesscentral: in the URL Template field.

Create a Connection to Dynamics 365 Business Central Data

Follow the steps below to add credentials and other required connection properties.

1. In the Databases menu, click New Connection.
2. In the Create new connection wizard that results, select the driver.
3. On the next page of the wizard, click the driver properties tab.

4. Enter values for authentication credentials and other properties required to connect to Dynamics 365 Business Central.

   To authenticate to Dynamics 365 Business Central, you must provide the User and AccessKey properties.

   To obtain the User and AccessKey values, navigate to the Users page in Dynamics 365 Business Central and then click on Edit. The User Name and Web Service Access Key values are what you will enter as the User and AccessKey connection string properties. Note that the User Name is not your email address. It is a shortened user name.

   To connect to data, specify OrganizationUrl. If you have multiple companies in your organization, you must also specify the Company to indicate which company you would like to connect to. Company does not need to be specified if you have only one company.

   Built-in Connection String Designer

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

   java -jar cdata.jdbc.d365businesscentral.jar

   Fill in the connection properties and copy the connection string to the clipboard.

   Below is a typical connection string:

   jdbc:d365businesscentral:OrganizationUrl=https://myaccount.financials.dynamics.com/;

Query Dynamics 365 Business Central Data

You can now query information from the tables exposed by the connection: Right-click a Table and then click Edit Table. The data is available on the Data tab.