Microsoft Dynamics 365 Business Central Setup Guide Beta

Follow our setup guide to connect Microsoft Dynamics 365 Business Central to Fivetran.

Prerequisites

To connect Microsoft Dynamics 365 Business Central to Fivetran, you need:

• a Microsoft Dynamics 365 Business Central account with Administrator privileges
• a Business Central sandbox environment with a valid license to develop AL extensions
• Visual Studio Code (VS Code)

  NOTE: For more information about installing VS Code, see its documentation.

Setup instructions

Install AL Language extension

1. Open VS Code.

2. On the navigation menu, click the Extensions icon and search for AL Language extension for Microsoft Dynamics 365 Business Central.

3. In the search results, click Install for AL Language extension for Microsoft Dynamics 365 Business Central.

   

4. Once the installation is complete, restart VS Code.

Create AL package

1. In VS Code, open the command palette and select AL: Go! to create an AL package in your local machine.

   TIP: You can open the command palette using the following keyboard shortcuts:

   • Windows: ctrl + shift + p
   • macOS: cmd + shift + p

2. Specify the path to the folder where you want to create the package and press Enter.
3. Select the latest AL runtime version.

   NOTE:

   • You must select a runtime version higher than v7.0.
   • We recommend that you use AL runtime version 12.0 (Business Central 2023 release wave 2). With runtime 13.0 (Business Central 2024 release wave 1), you may encounter issues while installing your AL package on your Business Central environment.
   • For more information about choosing runtime versions, see Business Central's documentation.

4. Select Microsoft cloud sandbox for online account as your server.

Connect VS Code instance to source

1. On the navigation menu, click the Explorer icon and open the launch.json file.

2. In the JSON content of the file, set the value of enviornmentName to the name of a sandbox environment name in your Business Central account.

3. Save and close the launch.json file.

4. Open the command palette and select AL: Download symbols.

5. In the pop-up window, click Copy & Open. VS Code will copy a code to your clipboard and will redirect you to Microsoft's login page.

   

6. On the Microsoft's login page, paste the code from your clipboard and click Next.

   

7. Log in to your Business Central Administrator account.

8. In all the confirmation windows, click Continue to connect your local VS Code instance to your Business Central account.

9. Go to VS Code. You will see a confirmation message indicating that the download of symbols was successful.

Specify ID range for API pages

1. On the navigation menu, click the Explorer icon and select the app.json file.

   

2. In the JSON content of the file, change the values for the idRanges setting. Set the value of from to 90000 and the value of to to 90149.

   NOTE: If the ID range from 90000 through 90149 is already used by another package, specify a different range that is available for use.

   

3. Save and close the app.json file.

Add API pages

1. Download the InitialSetup.al file from our GitHub repository to the AL package you created in Step 2. This file contains pre-defined API pages for the standard tables in Business Central. If you do not want to download the file, you can copy its contents into a new AL file (.al file) and store it in your AL package.

2. Verify whether the AL file contains API pages for all the tables you want to sync. If it doesn't, create new API pages for the missing tables. You can add the new pages to the same AL file or create a new AL file for them in your AL package.

   IMPORTANT: You must expose the systemId and systemModifiedAt columns in every API page you create. Both column names are case-sensitive.

3. Verify whether the id values for all the tables, API pages, and code units in your AL package are within the idRanges values you specified in Step 4.

4. Go to VS Code and save all the AL files in your AL package.

NOTE :

• In the InitialSetup.al file, the tables and their columns in API pages are based on the US region. If your Business Central account is mapped to a different region, some tables or columns may differ. In such cases, you must add or remove the respective columns accordingly.
• If you get any compiler warning for the API page columns, see our troubleshooting documentation.

Generate permission set

1. Open the command palette and select AL: Generate permission set as XML file containing current extension object. This will generate a extensionsPermissionSet.xml file in your AL package.
2. Open the extensionsPermissionSet.xml file and make a note of the RoleId value.
3. Save all the files in the AL package.

Install AL package

Install AL package on sandbox environment

1. In VS Code, click Run without Debugging on the Run menu.

   

   NOTE: You can track the logs in the DEBUG CONSOLE panel to identify the errors (if any). For more information about resolving the errors, see our troubleshooting documentation.

2. Once the package is installed, you will be redirected to your Business Central account.

Install AL package on production environment

1. In VS Code, open the command palette and select AL: package. This generates a .app file in the AL package you created in Step 2.

2. Go to your Business Central account.

3. Switch to any company in the production environment.

4. Go to the Extension Management page.

5. Go to the Manage tab and click Upload Extension.

   

6. In the Upload And Deploy Extension window, upload the newly generated .app file from your AL package.

   

7. Set the acknowledgement toggle to ON.

8. Click Deploy.

   NOTE: To see the deployment status, go to the Manage tab and click Installation Status. If the deployment fails, see our troubleshooting documentation or contact Business Central's support team.

Allow HTTP requests for AL package

IMPORTANT: You must perform this step if you want us to capture deletes for your source tables.

1. In your Business Central account, go to the sandbox or production environment where you installed your AL package in Step 7.

2. Go to the Extension Management page and select your AL package.

3. Set the Allow HttpClient Requests toggle to ON.

   

Assign permission set to user authenticating connection

1. Go to your Business Central account.
2. Switch to the environment where you installed the AL package.
3. Go to the Users page and select the user you want to use to authenticate Fivetran's Business Central connector.
4. Click New Line.
5. In the Permission Set column for the new line, enter the RoleId value you found in the extensionsPermissionSet.xml file.
6. Click New Line again and then in Permission Set column for the new line, add the D365 Read permission set.
7. (Optional) If you want to sync the data of a subset of companies, create a New Line with the same permission set for each company whose data you want to sync instead of the blank company.

NOTE :

• Leaving the Company column blank assigns the permission set to all companies.
• If you have added custom tables to your AL package, provide the necessary Read permissions to table, tableData, and page types of the custom tables.

Assign permission set to all users

1. Go to your Business Central account.

2. Switch to the environment where you installed the AL package.

3. Go to the Users page.

4. Go to Related > Permissions > Permission Set by User.

   

5. For every company in the environment, assign the FIVETRAN_SETUP permission set to all users who can delete records in the environment.

6. To make sure we capture and mark the deletes in your destination, assign the FIVETRAN_SETUP permission set to all the users who have authenticated any integration that can delete records in the environment.

Find tenant ID

Find your tenant ID in your Business Central URL and make a note of it. For example, if your Business Central URL is https://businesscentral.dynamics.com/fivetran/, then your tenant ID is fivetran.

Find environment name

1. In the top right corner of your Business Central dashboard, click the Environment icon.

2. Make a note of your Business Central environment. You will need it to configure Fivetran.

   

Finish Fivetran configuration

1. In the connector setup form, enter the Destination schema name of your choice.
2. Enter the Tenant ID you found.
3. Enter the Environment name you found.
4. Click Authorize. You will be redirected to your Business Central account to authorize Fivetran's access.
5. Click Accept to authorize Fivetran's access. You will be redirected back to Fivetran.
6. Select the Companies whose data you'd like to sync.
7. Click Save & Test. Fivetran will take it from here and sync your Business Central data.

Related articles

description Connector Overview

account_tree Schema Information

settings API Connector Configuration

home Documentation Home