Discover how a bimodal integration strategy can address the major data management challenges facing your organization today.
Get the Report →Use JayDeBeApi to access Workday Data in Python
Use standard Python scripting and the development environment of your choice to access live Workday data.
Access Workday data with Python scripts and standard SQL on any machine where Python and Java can be installed. You can use the CData JDBC Driver for Workday and the JayDeBeApi module to work with remote Workday data in Python. By using the CData Driver, you are leveraging a driver written for industry-proven standards to access your data in the popular Python language. This article shows how to use the driver to execute SQL queries to Workday and visualize Workday data with standard Python.
Use the JayDeBeApi module
JayDeBeApi is a Python library that serves as a JDBC (Java Database Connectivity) bridge, allowing Python programs to interact with Java databases, including CData JDBC Drivers. Use the pip install command to install the module:
pip install JayDeBeApi
Create the JDBC URL
Once you have JayDeBeApi installed, you are ready to work with Workday data in Python using SQL.
To connect, there are three pieces of information required: Authentication, API URL, and WSDL URL.
Authentication
To authenticate, specify your User and Password. Note that you must append your Tenant to your User separated by an '@' character. For instance, if you normally log in with 'geraldg' and your Tenant is 'mycompany_mc1', then your User should be specified as 'geraldg@mycompany_mc1'.
API URL
The API URL may be specified either directly via APIURL, or it may be constructed from the Tenant, Service, and Host. The APIURL is constructed in the following format: <Host>/ccx/service/<Tenant>/<Service>.
WSDL URL
The WSDLURL may be specified in its entirety, or may be constructed from the Service and WSDLVersion connection properties. The WSDLURL is constructed in the following format: https://community.workday.com/sites/default/files/file-hosting/productionapi/<Service>/<WSDLVersion>/<Service>.wsdl
Built-in Connection String Designer
For assistance in constructing the JDBC URL, use the connection string designer built into the Workday JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.
java -jar cdata.jdbc.workday.jar
Fill in the connection properties and copy the connection string to the clipboard.
Below is a sample variable assignment, including a typical JDBC connection string:
jdbc_url = "jdbc:workday:User=myuser;Password=mypassword;Tenant=mycompany_gm1;Host=https://wd3-impl-services1.workday.com"
Access Workday data in Python
With the JDBC URL configured, you only need the absolute path to the JDBC driver JAR file, which is in the "lib" folder in the installation directory ("C:\Program Files\CData[product_name] 20XX\lib\cdata.jdbc.workday.jar" on Windows).
NOTE: If you haven't already, set the JAVA_HOME environment variable to the Java installation directory.
Use code similar to the follow to read and print data from Workday:
import jaydebeapi
#The JDBC connection string
jdbc_url = "jdbc:workday:User=myuser;Password=mypassword;Tenant=mycompany_gm1;Host=https://wd3-impl-services1.workday.com"
username = "****"
password = "****"
#The absolute Path to the JDBC driver JAR file, typically:
jdbc_driver_jar = "C:\Program Files\CData[product_name] 20XX\lib\cdata.jdbc.workday.jar"
conn = jaydebeapi.connect(
"cdata.jdbc.workday.WorkdayDriver",
jdbc_url,
[username, password],
jdbc_driver_jar,
)
cursor = conn.cursor()
cursor.execute("SELECT * FROM Workers;")
results = cursor.fetchall()
for row in results:
print(row)
cursor.close()
conn.close()
Free trial & more information
Download a free, 30-day trial of the CData JDBC Driver for Workday and start working with your live Workday data in Python. Reach out to our Support Team if you have any questions.