How to Build an ETL App for Dynamics 365 Business Central Data in Python with CData Connect AI

The rich ecosystem of Python modules lets you get to work quickly and integrate your systems more effectively. With the CData Connect AI Python SDK and the petl framework, you can build Dynamics 365 Business Central-connected applications and pipelines for extracting, transforming, and loading Dynamics 365 Business Central data. This article shows how to connect to Connect AI and use petl to extract, transform, and load Dynamics 365 Business Central data.

The Connect AI Python SDK (cdata-connect-ai) is a DB-API 2.0 (PEP 249) compliant client, so petl can read directly from the SDK connection with etl.fromdb. There is no driver to install per source: connect with a Personal Access Token and build your pipeline.

Connect to Dynamics 365 Business Central in Connect AI

CData Connect AI uses a straightforward, point-and-click interface to connect to data sources.

1. Log into Connect AI, click Sources, and then click Add Connection

2. Select "Dynamics 365 Business Central" from the Add Connection panel

3. Enter the necessary authentication properties to connect to Dynamics 365 Business Central.

   To authenticate to Dynamics 365 Business Central, you must select an AuthScheme and provide the required properties (OAuth by default).

   All Methods

   Specify the 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.

   Access Key

   To authenticate with an Access Key, set AuthScheme to "AccessKey" and 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.

   If you wish to authenticate through other methods, refer to the Help documentation.

   
4. Click Save & Test
5. Navigate to the Permissions tab and update the user-based permissions.

Generate a Personal Access Token (PAT)

The Python SDK authenticates to Connect AI with your account email and a Personal Access Token (PAT). It is best practice to create a separate PAT for each application to maintain granularity of access.

1. Click the Gear icon () at the top right of the Connect AI app to open the Settings page.
2. On the Settings page, go to the Access Tokens section and click Create PAT.
3. Give the PAT a name and click Create.
4. The PAT is only visible at creation, so copy it and store it securely.

Install Required Modules

Install the SDK and the petl framework using the pip utility:

pip install cdata-connect-ai
pip install petl

Build an ETL App for Dynamics 365 Business Central Data in Python

Once the required modules are installed, you are ready to build the ETL app. Code snippets follow, but the full source code is available at the end of the article.

First, import the modules and connect to Connect AI with your account email and PAT:

import petl as etl
import cdata_connect_ai

conn = cdata_connect_ai.connect(
    username="[email protected]",
    password="<your_pat>",
)

Create a SQL Statement to Query Dynamics 365 Business Central

Use SQL to create a statement for querying Dynamics 365 Business Central. In this article, we read data from the Accounts entity. Identifiers are three-part: <Connection>.<Schema>.<Table>, where the connection name defaults to the source name (for example, D365BusinessCentral1).

sql = (
    "SELECT accountid, Name "
    "FROM [D365BusinessCentral1].[D365BusinessCentral].[Accounts] "
    "WHERE Name = 'MyAccount'"
)

Extract, Transform, and Load the Dynamics 365 Business Central Data

With a connection and query in hand, use petl to extract, transform, and load the Dynamics 365 Business Central data. In this example, we extract Dynamics 365 Business Central data, sort the data by the Name column, and load the data into a CSV file.

table1 = etl.fromdb(conn, sql)

table2 = etl.sort(table1, 'Name')

etl.tocsv(table2, 'accounts_data.csv')

Load New Rows Back into Dynamics 365 Business Central

When Dynamics 365 Business Central supports writes, load rows back with a batch INSERT. The SDK's executemany takes @name placeholders and a list of parameter dictionaries, one per row.

cur = conn.cursor()
cur.executemany(
    "INSERT INTO [D365BusinessCentral1].[D365BusinessCentral].[Accounts] (accountid, Name) "
    "VALUES (@val1, @val2)",
    [
        {"@val1": "New value 1", "@val2": "New value 1"},
        {"@val1": "New value 2", "@val2": "New value 2"},
    ],
)
print(f"Rows inserted: {cur.rowcount}")

conn.close()

Note: Even for writable sources, a read-only PAT or connection permission will reject write operations.

With the CData Connect AI Python SDK, you can work with Dynamics 365 Business Central data just like you would with any database, including direct access to data in ETL packages like petl.

More Information and Free Trial

Now you can pipe live Dynamics 365 Business Central data through petl using the CData Connect AI Python SDK. For more information on connecting to Dynamics 365 Business Central (and hundreds of other data sources), visit the Connect AI page. Sign up for a free trial and start building data pipelines for live Dynamics 365 Business Central data in Python.

Full Source Code

import petl as etl
import cdata_connect_ai

conn = cdata_connect_ai.connect(
    username="[email protected]",
    password="<your_pat>",
)

sql = (
    "SELECT accountid, Name "
    "FROM [D365BusinessCentral1].[D365BusinessCentral].[Accounts] "
    "WHERE Name = 'MyAccount'"
)

table1 = etl.fromdb(conn, sql)

table2 = etl.sort(table1, 'Name')

etl.tocsv(table2, 'accounts_data.csv')

cur = conn.cursor()
cur.executemany(
    "INSERT INTO [D365BusinessCentral1].[D365BusinessCentral].[Accounts] (accountid, Name) "
    "VALUES (@val1, @val2)",
    [
        {"@val1": "New value 1", "@val2": "New value 1"},
        {"@val1": "New value 2", "@val2": "New value 2"},
    ],
)
print(f"Rows inserted: {cur.rowcount}")
conn.close()