Use Dash to Build to Web Apps on Dynamics 365 Data

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, the pandas module, and the Dash framework, you can build Dynamics 365-connected web applications for Dynamics 365 data. This article shows how to connect to Dynamics 365 with the CData Connector and use pandas and Dash to build a simple web app for visualizing 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 pandas
pip install dash
pip install dash-daq

Visualize Dynamics 365 Data in Python

Once the required modules and frameworks are installed, we are ready to build our web 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 os
import dash
import dash_core_components as dcc
import dash_html_components as html
import pandas as pd
import cdata.dynamics365 as mod
import plotly.graph_objs as go

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")")

Execute SQL to Dynamics 365

Use the read_sql function from pandas to execute any SQL statement and store the result set in a DataFrame.

df = pd.read_sql("SELECT GoalHeadingId, Name FROM GoalHeadings WHERE Name = 'MyAccount'", cnxn)

Configure the Web App

With the query results stored in a DataFrame, we can begin configuring the web app, assigning a name, stylesheet, and title.

app_name = 'dash-dynamics365edataplot'

external_stylesheets = ['https://codepen.io/chriddyp/pen/bWLwgP.css']

app = dash.Dash(__name__, external_stylesheets=external_stylesheets)
app.title = 'CData + Dash'

Configure the Layout

The next step is to create a bar graph based on our Dynamics 365 data and configure the app layout.

trace = go.Bar(x=df.GoalHeadingId, y=df.Name, name='GoalHeadingId')

app.layout = html.Div(children=[html.H1("CData Extension + Dash", style={'textAlign': 'center'}),
	dcc.Graph(
		id='example-graph',
		figure={
			'data': [trace],
			'layout':
			go.Layout(title='Dynamics 365 GoalHeadings Data', barmode='stack')
		})
], className="container")

Set the App to Run

With the connection, app, and layout configured, we are ready to run the app. The last lines of Python code follow.

if __name__ == '__main__':
    app.run_server(debug=True)

Now, use Python to run the web app and a browser to view the Dynamics 365 data.

python dynamics365-dash.py

Free Trial & More Information

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

Full Source Code

import os
import dash
import dash_core_components as dcc
import dash_html_components as html
import pandas as pd
import cdata.dynamics365 as mod
import plotly.graph_objs as go

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

df = pd.read_sql("SELECT GoalHeadingId, Name FROM GoalHeadings WHERE Name = 'MyAccount'", cnxn)
app_name = 'dash-dynamics365dataplot'

external_stylesheets = ['https://codepen.io/chriddyp/pen/bWLwgP.css']

app = dash.Dash(__name__, external_stylesheets=external_stylesheets)
app.title = 'CData + Dash'
trace = go.Bar(x=df.GoalHeadingId, y=df.Name, name='GoalHeadingId')

app.layout = html.Div(children=[html.H1("CData Extension + Dash", style={'textAlign': 'center'}),
	dcc.Graph(
		id='example-graph',
		figure={
			'data': [trace],
			'layout':
			go.Layout(title='Dynamics 365 GoalHeadings Data', barmode='stack')
		})
], className="container")

if __name__ == '__main__':
    app.run_server(debug=True)