Using the CData ODBC Driver for SageHR 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 SageHR 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 SageHR as well as PyCharm.

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.

Connect to SageHR

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.

Start by setting the Profile connection property to the location of the SageHR Profile on disk (e.g. C:\profiles\SageHR.apip). Next, set the ProfileSettings connection property to the connection string for SageHR (see below).

SageHR API Profile Settings

Navigate to Settings > Integrations > API in your SageHR account and click Enable API Access to obtain your API key. Your Subdomain is the prefix of your SageHR URL.

Below is the syntax for a DSN:

[CData API Source]
Driver = CData ODBC Driver for SageHR
Description = My Description
Profile = C:\profiles\SageHR.apip
ProfileSettings = 'APIKey = your_api_key
Subdomain = your_subdomain'

Execute SQL to SageHR

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 API};Profile = C:\profiles\SageHR.apip;ProfileSettings = 'APIKey = your_api_key;Subdomain = your_subdomain';')
cursor = cnxn.cursor()
cursor.execute("SELECT ApplicantId, Action FROM ApplicantActions WHERE ApplicantId = '12345'")
rows = cursor.fetchall()
for row in rows:
  print(row.ApplicantId, row.Action)

After connecting to SageHR in PyCharm using the CData ODBC Driver, you will be able to build Python apps with access to SageHR 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].