Use Dash to Build to Web Apps on Adobe Commerce 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 Adobe Commerce, the pandas module, and the Dash framework, you can build Adobe Commerce-connected web applications for Adobe Commerce data. This article shows how to connect to Adobe Commerce with the CData Connector and use pandas and Dash to build a simple web app for visualizing Adobe Commerce data.

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

Connecting to Adobe Commerce Data

Connecting to Adobe Commerce 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.

Adobe Commerce uses the OAuth 1 authentication standard. To connect to the Adobe Commerce REST API, you will need to obtain values for the OAuthClientId, OAuthClientSecret, and CallbackURL connection properties by registering an app with your Adobe Commerce system. See the "Getting Started" section in the help documentation for a guide to obtaining the OAuth values and connecting.

You will also need to provide the URL to your Adobe Commerce system. The URL depends on whether you are using the Adobe Commerce REST API as a customer or administrator.

• Customer: To use Adobe Commerce as a customer, make sure you have created a customer account in the Adobe Commerce homepage. To do so, click Account -> Register. You can then set the URL connection property to the endpoint of your Adobe Commerce system.

• Administrator: To access Adobe Commerce as an administrator, set CustomAdminPath instead. This value can be obtained in the Advanced settings in the Admin menu, which can be accessed by selecting System -> Configuration -> Advanced -> Admin -> Admin Base URL.

  If the Use Custom Admin Path setting on this page is set to YES, the value is inside the Custom Admin Path text box; otherwise, set the CustomAdminPath connection property to the default value, which is "admin".

After installing the CData Adobe Commerce Connector, follow the procedure below to install the other required modules and start accessing Adobe Commerce 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 Adobe Commerce 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.adobe commerce as mod
import plotly.graph_objs as go

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

cnxn = mod.connect("OAuthClientId=MyConsumerKey;OAuthClientSecret=MyConsumerSecret;CallbackURL=http://127.0.0.1:33333;Url=https://myAdobe Commercehost.com;InitiateOAuth=GETANDREFRESH;OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")")

Execute SQL to Adobe Commerce

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 Name, Price FROM Products WHERE Style = 'High Tech'", 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-adobe commerceedataplot'

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 Adobe Commerce data and configure the app layout.

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

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='Adobe Commerce Products 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 Adobe Commerce data.

python adobe commerce-dash.py

Free Trial & More Information

Download a free, 30-day trial of the CData Python Connector for Adobe Commerce to start building Python apps with connectivity to Adobe Commerce 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.adobe commerce as mod
import plotly.graph_objs as go

cnxn = mod.connect("OAuthClientId=MyConsumerKey;OAuthClientSecret=MyConsumerSecret;CallbackURL=http://127.0.0.1:33333;Url=https://myAdobe Commercehost.com;InitiateOAuth=GETANDREFRESH;OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")

df = pd.read_sql("SELECT Name, Price FROM Products WHERE Style = 'High Tech'", cnxn)
app_name = 'dash-adobe commercedataplot'

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.Name, y=df.Price, name='Name')

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='Adobe Commerce Products Data', barmode='stack')
		})
], className="container")

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