Query Dynamics 365 Business Central Data in ColdFusion

The CData JDBC Driver for Dynamics 365 Business Central seamlessly integrates connectivity to Dynamics 365 Business Central data with the rapid development tools in ColdFusion. This article shows how to connect to Dynamics 365 Business Central data in ColdFusion and query Dynamics 365 Business Central tables.

Create a JDBC Data Source for Dynamics 365 Business Central in ColdFusion

The JDBC data source enables you to execute SQL from standard ColdFusion tags like cfquery and CFScript like executeQuery.

1. Copy the driver JAR and .lic file from the installation directory onto the ColdFusion classpath. For example, copy the files into C:\MyColdFusionDirectory\cfusion\wwwroot\WEB-INF\lib. Or, open the Java and JVM page in the ColdFusion Administrator and enter the path to the files in the ColdFusion Class Path box.

   The JAR and license for the driver are located in the lib subfolder of the installation directory.

   Restart the server after this step.

2. Add the driver as a data source:

   From the ColdFusion administrator interface, expand the Data & Services node and click Data Sources. In the Add New Data Source section, enter a name for the data source and select Other in the Driver menu.

3. Populate the driver properties:

   • JDBC URL: Enter connection properties in the JDBC URL. The JDBC URL begins with jdbc:d365businesscentral: and is 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.

     A typical JDBC URL is below:

     jdbc:d365businesscentral:OrganizationUrl=https://myaccount.financials.dynamics.com/;
   • Driver Class: Enter the driver class. The driver class is cdata.jdbc.d365businesscentral.D365BusinessCentralDriver.
   • Driver Name: Enter a user-defined name for the driver.
   • Username: Enter the username used to authenticate.
   • Password: Enter the password used to authenticate.

You can now test the connection by enabling the CData Dynamics 365 Business Central data source in the Actions column. After reporting a status of OK, the Dynamics 365 Business Central data source is ready for use.

Execute Queries

The cfquery tag can pass SQL statements to Dynamics 365 Business Central, including INSERT, UPDATE, and DELETE.. Use the cfqueryparam tag to create parameterized queries and prevent SQL injection through the query string.

Note: To use the cfquery and cfscript, create a .cfm file. Inside the .cfm file, write the code to execute the query (see below). Place the file directly in the root directory of your web server (e.g., wwwroot in Adobe ColdFusion). Restart the service after placing the file for the changes to take effect.

Below is the equivalent in CFScript:

<cfscript>
result = queryExecute(
  "SELECT * FROM Accounts WHERE Name = ?", 
  [
    { value="MyAccount", cfsqltype="cf_sql_varchar" }
  ],
  { datasource="CDataD365BusinessCentral" }
);

writeDump( var= result );
</cfscript> 

You can then make requests to your .cfm like the following: