Using the CData ODBC Driver for Factorial 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 Factorial 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 Factorial 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 Factorial

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.

Authentication

Factorial uses OAuth 2.0 for authentication to connect to your HR data or to allow other users to connect to their data.

Using OAuth Authentication

To connect using OAuth, follow these steps:

1. Navigate to your Factorial admin panel and create a new OAuth application.
2. Copy the Client ID and Client Secret from your application configuration.
3. Configure the following connection properties:

After setting the following connection properties, you are ready to connect:

• AuthScheme: Set this to OAuth.
• OAuthClientId: Set this to your OAuth Client ID.
• OAuthClientSecret: Set this to your OAuth Client Secret.
• Scope: Set this to specify the data access permissions (default: "read write").

Below is the syntax for a DSN:

[CData API Source]
Driver = CData ODBC Driver for Factorial
Description = My Description
Profile = C:\profiles\Factorial.apip
AuthScheme = OAuth
OAuthClientId = your_client_id
OAuthClientSecret = your_client_secret
CallbackUrl = your_callback_url

Execute SQL to Factorial

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\Factorial.apip;AuthScheme = OAuth;OAuthClientId = your_client_id;OAuthClientSecret = your_client_secret;CallbackUrl = your_callback_url;')
cursor = cnxn.cursor()
cursor.execute("SELECT ,  FROM Agreements WHERE ProcessId = '123'")
rows = cursor.fetchall()
for row in rows:
  print(row., row.)

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