How to Build an ETL App for Dynamics 365 Data in Python with CData

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

With built-in, optimized data processing, the CData Python Connector offers unmatched performance for interacting with live Dynamics 365 data in Python. When you issue complex SQL queries from Dynamics 365, the driver pushes supported SQL operations, like filters and aggregations, directly to Dynamics 365 and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations).

Connecting to Dynamics 365 Data

Connecting to Dynamics 365 data looks just like connecting to any relational data source. Create a connection string using the required connection properties. For this article, you will pass the connection string as a parameter to the create_engine function.

Edition and OrganizationUrl are required connection properties. The Dynamics 365 connector supports connecting to the following editions: CustomerService, FieldService, FinOpsOnline, FinOpsOnPremise, HumanResources, Marketing, ProjectOperations and Sales.

For Dynamics 365 Business Central, use the separate Dynamics 365 Business Central driver.

OrganizationUrl is the URL to your Dynamics 365 organization. For instance, https://orgcb42e1d0.crm.dynamics.com

After installing the CData Dynamics 365 Connector, follow the procedure below to install the other required modules and start accessing Dynamics 365 through Python objects.

Install Required Modules

Use the pip utility to install the required modules and frameworks:

pip install petl
pip install pandas

Build an ETL App for Dynamics 365 Data in Python

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

First, be sure to import the modules (including the CData Connector) with the following:

import petl as etl
import pandas as pd
import cdata.dynamics365 as mod

You can now connect with a connection string. Use the connect function for the CData Dynamics 365 Connector to create a connection for working with Dynamics 365 data.

cnxn = mod.connect("OrganizationUrl=https://myaccount.operations.dynamics.com/;Edition=Sales;InitiateOAuth=GETANDREFRESH;OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")")

Create a SQL Statement to Query Dynamics 365

Use SQL to create a statement for querying Dynamics 365. In this article, we read data from the GoalHeadings entity.

sql = "SELECT GoalHeadingId, Name FROM GoalHeadings WHERE Name = 'MyAccount'"

Extract, Transform, and Load the Dynamics 365 Data

With the query results stored in a DataFrame, we can use petl to extract, transform, and load the Dynamics 365 data. In this example, we extract Dynamics 365 data, sort the data by the Name column, and load the data into a CSV file.

Loading Dynamics 365 Data into a CSV File

table1 = etl.fromdb(cnxn,sql)

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

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

In the following example, we add new rows to the GoalHeadings table.

Adding New Rows to Dynamics 365

table1 = [ ['GoalHeadingId','Name'], ['NewGoalHeadingId1','NewName1'], ['NewGoalHeadingId2','NewName2'], ['NewGoalHeadingId3','NewName3'] ]

etl.appenddb(table1, cnxn, 'GoalHeadings')

With the CData Python Connector for Dynamics 365, you can work with Dynamics 365 data just like you would with any database, including direct access to data in ETL packages like petl.

Free Trial & More Information

Download a free, 30-day trial of the CData Python Connector for Dynamics 365 to start building Python apps and scripts with connectivity to Dynamics 365 data. Reach out to our Support Team if you have any questions.

Full Source Code

import petl as etl
import pandas as pd
import cdata.dynamics365 as mod

cnxn = mod.connect("OrganizationUrl=https://myaccount.operations.dynamics.com/;Edition=Sales;InitiateOAuth=GETANDREFRESH;OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")")

sql = "SELECT GoalHeadingId, Name FROM GoalHeadings WHERE Name = 'MyAccount'"

table1 = etl.fromdb(cnxn,sql)

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

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

table3 = [ ['GoalHeadingId','Name'], ['NewGoalHeadingId1','NewName1'], ['NewGoalHeadingId2','NewName2'], ['NewGoalHeadingId3','NewName3'] ]

etl.appenddb(table3, cnxn, 'GoalHeadings')