Connect to Dynamics 365 Business Central Data in DBVisualizer

The CData JDBC Driver for Dynamics 365 Business Central implements JDBC standards to provide connectivity to Dynamics 365 Business Central data in applications ranging from business intelligence tools to IDEs. This article shows how to establish a connection to Dynamics 365 Business Central data in DBVisualizer and use the table editor to edit and save Dynamics 365 Business Central data.

Create a New JDBC Data Source for Dynamics 365 Business Central Data

Follow the steps below to use the Driver Manager to provide connectivity to Dynamics 365 Business Central data from DBVisualizer tools.

1. In DBVisualizer, click Tools -> Driver Manager -> Create a New Driver.
2. Enter a name for the data source.
3. Enter the following in the URL Format box: jdbc:d365businesscentral:
   The DBVisualizer Driver Manager.
4. In the User Specified tab, click the Open File button and select the cdata.jdbc.d365businesscentral.jar file, located in the lib subfolder of the installation directory.
5. In the Driver Class menu, select the D365BusinessCentralDriver class, cdata.jdbc.d365businesscentral.D365BusinessCentralDriver.

Define the Connection to the JDBC Data Source

Follow the steps below to save connection properties in the JDBC URL.

1. In the Database tab, right-click the Database Connection node and click Create a Database Connection.

2. In the Connection section, set the following options:

   • Database Type: If you selected the wizard option, the database type is automatically detected. If you selected the "No Wizard" option, select the Generic or Auto Detect option in the Database Type menu.
   • Driver: Select the driver you just created.

   • Database URL: Enter the full JDBC URL. The syntax of the JDBC URL is jdbc:d365businesscentral: followed by the connection properties in a semicolon-separated list of name-value pairs.

     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.

     When you configure the JDBC URL, you may also want to set the Max Rows connection property. This will limit the number of rows returned, which is especially helpful for improving performance when designing reports and visualizations.

     A typical connection string is below:

     jdbc:d365businesscentral:OrganizationUrl=https://myaccount.financials.dynamics.com/;
   • Database UserId: The username to use to authenticate to Dynamics 365 Business Central.
   • Database Password: The password to use to authenticate to Dynamics 365 Business Central.

3. On the Connection tab, click Connect.

To browse through tables exposed by the Dynamics 365 Business Central JDBC Driver, right-click a table and click Open in New Tab.

To execute SQL queries, use the SQL Commander tool: Click SQL Commander -> New SQL Commander. Select the Database Connection, Database, and Schema from the available menus.

See the "Supported SQL" chapter in the help documentation for more information on the supported SQL. See the "Data Model" chapter for table-specific information.