Query Dynamics 365 Business Central Data in DataGrip

DataGrip is a database IDE that allows SQL developers to query, create, and manage databases. When paired with the CData JDBC Driver for Dynamics 365 Business Central, DataGrip can work with live Dynamics 365 Business Central data. This article shows how to establish a connection to Dynamics 365 Business Central data in DataGrip and use the table editor to load Dynamics 365 Business Central data.

Create a New Driver Definition for Dynamics 365 Business Central

The steps below describe how to create a new Data Source in DataGrip for Dynamics 365 Business Central.

1. In DataGrip, click File -> New > Project and name the project
2. In the Database Explorer, click the plus icon () and select Driver.
3. In the Driver tab:
   • Set Name to a user-friendly name (e.g. "CData Dynamics 365 Business Central Driver")
   • Set Driver Files to the appropriate JAR file. To add the file, click the plus (), select "Add Files," navigate to the "lib" folder in the driver's installation directory and select the JAR file (e.g. cdata.jdbc.d365businesscentral.jar).
   • Set Class to cdata.jdbc.d365businesscentral.D365BusinessCentral.jar
   Additionally, in the advanced tab you can change driver properties and some other settings like VM Options, VM environment, VM home path, DBMS, etc
   • For most cases, change the DBMS type to "Unknown" in Expert options to avoid native SQL Server queries (Transact-SQL), which might result in an invalid function error
4. Click "Apply" then "OK" to save the Connection

Configure a Connection to Dynamics 365 Business Central

1. Once the connection is saved, click the plus (), then "Data Source" then "CData Dynamics 365 Business Central Driver" to create a new Dynamics 365 Business Central Data Source.
2. In the new window, configure the connection to Dynamics 365 Business Central with a JDBC URL.

   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.

   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.

3. Set URL to the connection string, e.g., jdbc:d365businesscentral:OrganizationUrl=https://myaccount.financials.dynamics.com/;
4. Click "Apply" and "OK" to save the connection string

At this point, you will see the data source in the Data Explorer.

Execute SQL Queries Against Dynamics 365 Business Central

To browse through the Dynamics 365 Business Central entities (available as tables) accessible through the JDBC Driver, expand the Data Source.

To execute queries, right click on any table and select "New" -> "Query Console."

In the Console, write the SQL query you wish to execute. For example: SELECT accountid, Name FROM Accounts

Download a free, 30-day trial of the CData JDBC Driver for Dynamics 365 Business Central and start working with your live Dynamics 365 Business Central data in DataGrip. Reach out to our Support Team if you have any questions.