FireDAC Components for Dynamics 365 Business Central

Build 20.0.7654

Establishing a Connection

You can create and manage connections with the Data Explorer and the FireDAC Connection Editor wizards. See Connection Definitions for more information on creating connections from code and creating persistent, private, or temporary connections.

To connect to data, specify OrganizationUrl. The OrganizationUrl should be either the endpoint to your business central account such as https://businesscentral.dynamics.com/abc123/, or it should reference the web services root. Please see Business Central Endpoints for more details on how to specify the OrganizationUrl and which endpoints are available.

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.

User and Access Key Authentication

To authenticate to Dynamics 365 Business Central, you may provide the User and AccessKey connection properties. Microsoft recommends these for testing and development purposes, but discourages their use for production environments.

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.

OAuth Authentication

Microsoft recommends for production use cases to use OAuth authentication. Please see Using OAuth Authentication for details.

Authenticating using MSI Authentication

If you are running Dynamics 365 Business Central on an Azure VM, you can leverage Managed Service Identity (MSI) credentials to connect:

  • AuthScheme: Set this to AzureMSI.

The MSI credentials will then be automatically obtained for authentication.

Using the FireDAC Connection Editor

Complete the following steps to use the FireDAC Connection Editor to assign a Dynamics 365 Business Central connection to a TFDConnection object:

  1. Open a project and drop a TFDPhysCDataD365BusinessCentralDriverLink from the Tool Palette onto the Form Designer.
  2. Drop a TFDConnection object onto the Form Designer.
  3. Double-click the TFDConnection and select CDataD365BusinessCentral in the Driver Id menu.
  4. Define the necessary connection properties.
  5. To execute ad-hoc SQL statements based on this connection, enter SQL commands on the SQL Script tab.
  6. In the Form Designer, select the TFDConnection object and set the Connected property to true.

Using the Data Explorer

Complete the following steps to use the Data Explorer to define persistent connections that can be shared across applications and projects:

  1. Click View > Tool Windows > Data Explorer in RAD Studio and expand the FireDAC node.
  2. Right-click the CData Dynamics 365 Business Central Data Source node and click Add New Connection.
  3. Enter a name for the connection. The FireDAC Connection Editor opens.

Working with Persistent Connections

The connections you define in the Data Explorer can be assigned to a TFDConnection object by specifying the connection name in the TFDConnection object's ConnectionDefName property.

Browsing Data and Metadata

The Data Explorer also provides options for browsing Dynamics 365 Business Central objects at design time:

  • Expand the CData Dynamics 365 Business Central Data Source node in the Data Explorer to view the defined connections.
  • Expand a connection node to find the database objects available for a connection.
  • Drill down to a database object to find metadata such as primary keys.
  • To display data, double-click a table or view or right-click and click View.

Copyright (c) 2020 CData Software, Inc. - All rights reserved.
Build 20.0.7654