Using the CData ODBC Driver for Workday in PyCharm

The CData ODBC Drivers can be used in any environment that supports loading an ODBC Driver. In this tutorial we will explore using the CData ODBC Driver for Workday from within PyCharm. Included are steps for adding the CData ODBC Driver as a data source, as well as basic PyCharm code to query the data source and display results.

To begin, this tutorial will assume that you have already installed the CData ODBC Driver for Workday as well as PyCharm.

Getting Started

---

Add Pyodbc to the Project

Follow the steps below to add the pyodbc module to your project.

1. Click File -> Settings to open the project settings window.
2. Click Project Interpreter from the Project: YourProjectName menu.
3. To add pyodbc, click the + button and enter pyodbc.
4. Click Install Package to install pyodbc.

👁 Image

Connect to Workday

You can now connect with an ODBC connection string or a DSN. See the Getting Started section in the CData driver documentation for a guide to creating a DSN on your OS.

To connect to Workday, users need to find the Tenant and BaseURL and then select their API type.

Obtaining the BaseURL and Tenant

To obtain the BaseURL and Tenant properties, log into Workday and search for "View API Clients." On this screen, you'll find the Workday REST API Endpoint, a URL that includes both the BaseURL and Tenant.

The format of the REST API Endpoint is: https://domain.com/subdirectories/mycompany, where:

• https://domain.com/subdirectories/ is the BaseURL.
• mycompany (the portion of the url after the very last slash) is the Tenant.

For example, in the REST API endpoint https://wd3-impl-services1.workday.com/ccx/api/v1/mycompany, the BaseURL is https://wd3-impl-services1.workday.com and the Tenant is mycompany.

Using ConnectionType to Select the API

The value you use for the ConnectionType property determines which Workday API you use. See our Community Article for more information on Workday connectivity options and best practices.

Authentication

Your method of authentication depends on which API you are using.

• WQL, Reports as a Service, REST: Use OAuth authentication.
• SOAP: Use Basic or OAuth authentication.

See the Help documentation for more information on configuring OAuth with Workday.

Below is the syntax for a DSN:

[CData Workday Source]
Driver = CData ODBC Driver for Workday
Description = My Description
User = myuser
Password = mypassword
Tenant = mycompany_gm1
BaseURL = https://wd3-impl-services1.workday.com
ConnectionType = WQL
InitiateOAuth = GETANDREFRESH

Execute SQL to Workday

Instantiate a Cursor and use the execute method of the Cursor class to execute any SQL statement.

import pyodbc

cnxn = pyodbc.connect('DRIVER={CData ODBC Driver for Workday};User = myuser;Password = mypassword;Tenant = mycompany_gm1;BaseURL = https://wd3-impl-services1.workday.com;ConnectionType = WQL;InitiateOAuth = GETANDREFRESH;')
cursor = cnxn.cursor()
cursor.execute("SELECT Worker_Reference_WID, Legal_Name_Last_Name FROM Workers WHERE Legal_Name_Last_Name = 'Morgan'")
rows = cursor.fetchall()
for row in rows:
 print(row.Worker_Reference_WID, row.Legal_Name_Last_Name)

After connecting to Workday in PyCharm using the CData ODBC Driver, you will be able to build Python apps with access to Workday data as if it were a standard database. If you have any questions, comments, or feedback regarding this tutorial, please contact us at [email protected].