How to connect to Dynamics 365 Business Central Data with Squirrel SQL client

The CData JDBC Driver for Dynamics 365 Business Central enables you to execute queries to Dynamics 365 Business Central data in tools like Squirrel SQL Client. In this article, you will create a JDBC data source for Dynamics 365 Business Central data and execute queries.

Add the JDBC Driver for Dynamics 365 Business Central

Follow the steps below to add the driver JAR.

1. In Squirrel SQL, click Windows -> View Drivers.
2. Click the plus icon to open the Add Driver wizard.
3. In the Name box, enter a user-friendly name for the driver; for example, CData JDBC Driver for Dynamics 365 Business Central.
4. In the Example URL box, enter jdbc:d365businesscentral:
5. In the Extra Class Path tab, click Add.
6. In the file explorer dialog that opens, select the JAR file for the driver, located in the lib subfolder of the installation directory.
7. Click List Drivers to populate the Class Name menu with the class name for the driver, cdata.jdbc.d365businesscentral.D365BusinessCentralDriver.

Define Connection Properties

Follow the steps below to save connection properties in the driver alias.

1. Click Windows -> View Aliases.
2. In the pane that lists the aliases, click the plus icon.

3. In the Add Alias wizard that opens, the following fields are required for the JDBC driver:

   • Name: Enter a name for the alias; for example, CData Dynamics 365 Business Central Source.
   • Driver: Select the CData JDBC Driver for Dynamics 365 Business Central.
   • URL: Enter jdbc:d365businesscentral:
   👁 The alias definition, containing the connection parameters. (Salesforce is shown.)
   
4. If you want to define any additional properties, click Properties.
5. In the Driver properties tab of the dialog that appears, select the Use driver properties checkbox.
6. In the Specify column, select the checkboxes for the required connection properties.

   To authenticate to Dynamics 365 Business Central, you must select an AuthScheme and provide the required properties (OAuth by default).

   All Methods

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

   Access Key

   To authenticate with an Access Key, set AuthScheme to "AccessKey" and provide the and properties.

   To obtain the and 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 and connection string properties. Note that the User Name is not your email address. It is a shortened user name.

   If you wish to authenticate through other methods, refer to the Help documentation.

   Below is a typical connection string:

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

   👁 Connection properties automatically detected by Squirrel SQL. (Salesforce is shown.)
   
7. In the dialog that appears after you click OK, click connect to test the connection.

Discover Schemas and Query Dynamics 365 Business Central Data

After the metadata has loaded, a new tab for the Dynamics 365 Business Central data source is displayed. On the Objects subtab, you can discover schema information, such as the available tables and views.

👁 Column metadata for a table. (Salesforce is shown.)

To view table data, select the table on the Objects tab. The table data is then loaded in a grid on the Content tab.

To execute an SQL query, enter the query on the SQL tab and then click Run SQL (the runner icon). For example:

SELECT accountid, Name FROM Accounts