Ready to get started?

Download a free trial of the SAP Ariba Procurement Connector to get started:

 Download Now

Learn more:

SAP Ariba Procurement Icon SAP Ariba Procurement Python Connector

Python Connector Libraries for SAP Ariba Procurement Data Connectivity. Integrate SAP Ariba Procurement with popular Python tools like Pandas, SQLAlchemy, Dash & petl.

Use Dash to Build to Web Apps on SAP Ariba Procurement Data



Create Python applications that use pandas and Dash to build SAP Ariba Procurement-connected web apps.

The rich ecosystem of Python modules lets you get to work quickly and integrate your systems more effectively. With the CData Python Connector for SAP Ariba Procurement, the pandas module, and the Dash framework, you can build SAP Ariba Procurement-connected web applications for SAP Ariba Procurement data. This article shows how to connect to SAP Ariba Procurement with the CData Connector and use pandas and Dash to build a simple web app for visualizing SAP Ariba Procurement data.

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

Connecting to SAP Ariba Procurement Data

Connecting to SAP Ariba Procurement 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.

In order to connect with SAP Ariba Procurement, set the following:

  • ANID: Your Ariba Network ID.
  • ANID: Specify which API you would like the provider to retrieve SAP Ariba data from. Select the Buyer or Supplier API based on your business role (possible values are PurchaseOrdersBuyerAPIV1 or PurchaseOrdersSupplierAPIV1).
  • Environment: Indicate whether you are connecting to a test or production environment (possible values are TEST or PRODUCTION).

Authenticating with OAuth

After setting connection properties, you need to configure OAuth connectivity to authenticate.

  • Set AuthScheme to OAuthClient.
  • Register an application with the service to obtain the APIKey, OAuthClientId and OAuthClientSecret.

    For more information on creating an OAuth application, refer to the Help documentation.

Automatic OAuth

After setting the following, you are ready to connect:

    APIKey: The Application key in your app settings. OAuthClientId: The OAuth Client Id in your app settings. OAuthClientSecret: The OAuth Secret in your app settings.

When you connect, the provider automatically completes the OAuth process:

  1. The provider obtains an access token from SAP Ariba and uses it to request data.
  2. The provider refreshes the access token automatically when it expires.
  3. The OAuth values are saved in memory relative to the location specified in OAuthSettingsLocation.

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

You can now connect with a connection string. Use the connect function for the CData SAP Ariba Procurement Connector to create a connection for working with SAP Ariba Procurement data.

cnxn = mod.connect("ANID=AN02000000280;API=PurchaseOrdersBuyerAPI-V1;APIKey=wWVLn7WTAXrIRMAzZ6VnuEj7Ekot5jnU;AuthScheme=OAuthClient;InitiateOAuth=GETANDREFRESH;OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")")

Execute SQL to SAP Ariba Procurement

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 DocumentNumber, Revision FROM Orders WHERE OrderStatus = 'CHANGED'", 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-saparibaprocurementedataplot'

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 SAP Ariba Procurement data and configure the app layout.

trace = go.Bar(x=df.DocumentNumber, y=df.Revision, name='DocumentNumber')

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='SAP Ariba Procurement Orders 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 SAP Ariba Procurement data.

python saparibaprocurement-dash.py

Free Trial & More Information

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

cnxn = mod.connect("ANID=AN02000000280;API=PurchaseOrdersBuyerAPI-V1;APIKey=wWVLn7WTAXrIRMAzZ6VnuEj7Ekot5jnU;AuthScheme=OAuthClient;InitiateOAuth=GETANDREFRESH;OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")

df = pd.read_sql("SELECT DocumentNumber, Revision FROM Orders WHERE OrderStatus = 'CHANGED'", cnxn)
app_name = 'dash-saparibaprocurementdataplot'

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

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='SAP Ariba Procurement Orders Data', barmode='stack')
		})
], className="container")

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