Business Central
Prerequisite
DBSync replication uses OData endpoints in Business Central to extract schema/metadata and read data. Please configure the following before the kickoff call.
Essentials or Premium license assigned.
Recommended: Use a dedicated service account (not tied to a personal user).
Read-only permission set applied across relevant companies.
Suggested assignment:
D365 READ (if available in your environment).
D365 BUS FULL ACCESS with Write/Modify removed (if creating a custom set).
Or a custom “DBSync Replication – Read” permission set with:
Read (R) on all tables to be replicated.
Read access to OData metadata ($metadata).
SYSTEM APP – BASIC permission set (required for OData).
OData web services are published for target tables.
Confirm the OData V4 endpoint is enabled.
Example URL:
https://api.businesscentral.dynamics.com/v2.0/{tenantId}/{environment}/ODataV4/Company('{companyName}')Publish Web Services for each table/page to be replicated (Customers, Vendors, GL, Sales, etc.).
Ensure
$metadataendpoint is accessible for schema discovery.
Enterprise App in Entra with Financials.Read.All + User.Read.
When DBSync is registered as an Enterprise Application, confirm the following Delegated Permissions are granted and admin-consented:
Financials.Read.All (not ReadWrite) → provides read-only access to Business Central data.
User.Read → required for login.
offline_access → required for refresh tokens.
Admin consent is provided once during setup.
The service account must belong to the same tenant as the Business Central environment.
Business Central Administrator or Global Admin must provide consent once when registering the Enterprise App.
Dynamics 365 Business Central Administrator role should be provided
Getting Started
Get started by creating a profile and replicating your Business Central instance to your MySQL or SQL Server database.
Follow the Steps below for initial setup guidelines.
Steps to Start DBSync Replication Process:
Log in to your DBSync Business Central CRM Replication instance using your credentials.
Get started by clicking on the Add App to create a profile for configuring replication.
Select the option ‘Dynamics365crm’ as shown in the image above
Enter a desired profile name and click Save.
A new profile will now be created.
Click on the profile name.
You will be redirected to set up your Microsoft instance.
Business Central CRM Setup
Select the version you want to connect i.e., Cloud or On-Prem
Enter the endpoint URL of your desired profile
Click on Connect to Business Central CRM for instant web authentication. and the following steps would be witnessed:
A pop-up asking for your Business Central CRM credentials will appear on the screen
Provide the login credentials and click Log In
The User Name and Organization ID fields are automatically populated
Select the Environment
Prod
Sandbox
Select the company you want to connect to.
Click 'test connection' to verify you are connected to the application
Click Save
Click Next
You will be redirected to configure your Database.
Configure Database
Click the Database tab from the top navigation toolbar.
Select the type of database to which you wish to replicate the Business Central CRM instance linked in the previous step.
To start with, the database credentials of the user are required, such as Host, Port, Username, Password, Database Name, and Schema.
Based on all the details entered by the user, the URL field gets auto-filled.
Click Save
A pop-up confirming the Connection is saved will appear on the screen
Click Test Connection
A pop-up confirming the connection is established will appear on the screen.
Click Next
You will be redirected to configure Business Central CRM objects
Advanced Settings:
This Tab primarily focuses on 3 advanced settings:
File Download
Click the checkbox next to Download as local files to download into your local system
The URL for the download file directory is provided
Click the checkbox next to Keep Multiple Versions of Files. This will assist in keeping multiple versions of the files when downloading (Will rename older versions before downloading new ones)
2. Prefix settings:
Include a prefix if required, and enter the prefix details in the table below, which will get populated into the database.
Sync Business Central CRM objects to the database
Ensure you are connected to your Dynamics 365 CRM instance
Ensure you have configured the database
Once a user has connected to Business Central CRM, then objects will get synced, and it will show on the objects tab.
Select any " Business Central CRM objects" to sync into the database objects table section, as shown below.
Select the object fields you want to sync into the database from the "Available Fields" section and use the "exclude fields" section to filter out fields you don't want to sync into the database.
Click the RUN button and select the Clean Copy command to get an exact copy of your Business Central CRM-selected objects.
Choose any of the 2 functions to perform:
Run Process
Actions Performed
Clean Copy
Inserts a clean copy of Business Central CRM object records into respective database tables & columns.
Business Central CRM Replication Setup
To set up your instance follow the steps below:
Log in to DBSync Cloud Replication instance
Select the desired profile
Connect to Business Central CRM profile
Enter the endpoint URL of your desired profile
Click the blue icon Connect to Business Central CRM
A pop-up asking for your Business Central CRM credentials will appear on the screen
Provide the login credential and click Log In
The User Name and Organization ID fields are automatically populated
Click 'Test Connection' to verify you are connected to the application
Click Next
You will be redirected to configure your Database.
This completes your Source Setup. Proceed to Target Setup
Last updated