Ready to get started?

Learn more about the CData Python Connector for SAP SuccessFactors or download a free trial:

Download Now

Use Dash to Build to Web Apps on SAP SuccessFactors Data

The CData Python Connector for SAP SuccessFactors enables you to create Python applications that use pandas and Dash to build SAP SuccessFactors-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 SuccessFactors, the pandas module, and the Dash framework, you can build SAP SuccessFactors-connected web applications for SAP SuccessFactors data. This article shows how to connect to SAP SuccessFactors with the CData Connector and use pandas and Dash to build a simple web app for visualizing SAP SuccessFactors data.

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

Connecting to SAP SuccessFactors Data

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

You can authenticate to SAP Success Factors using Basic authentication or OAuth with SAML assertion.

Basic Authentication

You must provide values for the following properties to successfully authenticate to SAP Success Factors. Note that the provider will reuse the session opened by SAP Success Factors using cookies. Which means that your credentials will be used only on the first request to open the session. After that, cookies returned from SAP Success Factors will be used for authentication.

  • Url: set this to the URL of the server hosting Success Factors. Some of the servers are listed in the SAP support documentation (external link).
  • User: set this to the username of your account.
  • Password: set this to the password of your account.
  • CompanyId: set this to the unique identifier of your company.

OAuth Authentication

You must provide values for the following properties, which will be used to get the access token.

  • Url: set this to the URL of the server hosting Success Factors. Some of the servers are listed in the SAP support documentation (external link).
  • User: set this to the username of your account.
  • CompanyId: set this to the unique identifier of your company.
  • OAuthClientId: set this to the API Key that was generated in API Center.
  • OAuthClientSecret: the X.509 private key used to sign SAML assertion. The private key can be found in the certificate you downloaded in Registering your OAuth Client Application.
  • InitiateOAuth: set this to GETANDREFRESH.

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

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

cnxn = mod.connect("User=username;Password=password;CompanyId=CompanyId;Url=https://api4.successfactors.com;")

Execute SQL to SAP SuccessFactors

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 address1, zipCode FROM ExtAddressInfo WHERE city = 'Springfield'", 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-sapsuccessfactorsedataplot'

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

trace = go.Bar(x=df.address1, y=df.zipCode, name='address1')

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 SuccessFactors ExtAddressInfo 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 SuccessFactors data.

python sapsuccessfactors-dash.py

Free Trial & More Information

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

cnxn = mod.connect("User=username;Password=password;CompanyId=CompanyId;Url=https://api4.successfactors.com;")

df = pd.read_sql("SELECT address1, zipCode FROM ExtAddressInfo WHERE city = 'Springfield'", cnxn)
app_name = 'dash-sapsuccessfactorsdataplot'

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

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

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