Ready to get started?

Learn more about the CData ODBC Driver for FinancialForce or download a free trial:

Download Now

Using the CData ODBC Driver for FinancialForce in PyCharm

Connect to FinancialForce as an ODBC data source in PyCharm using the CData ODBC Driver for FinancialForce.

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 FinancialForce 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 FinancialForce 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 FinancialForce

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.

There are several authentication methods available for connecting to FinancialForce: login credentials, SSO, and OAuth.

Authenticating with a Login and Token

Set the User and Password to your login credentials. Additionally, set the SecurityToken. By default, the SecurityToken is required, but you can make it optional by allowing a range of trusted IP addresses.

To disable the security token:

  1. Log in to FinancialForce and enter "Network Access" in the Quick Find box in the setup section.
  2. Add your IP address to the list of trusted IP addresses.

To obtain the security token:

  1. Open the personal information page on FinancialForce.com.
  2. Click the link to reset your security token. The token will be emailed to you.
  3. Specify the security token in the SecurityToken connection property or append it to the Password.

Authenticating with OAuth

If you do not have access to the user name and password or do not want to require them, use the OAuth user consent flow. See the OAuth section in the Help for an authentication guide.

Connecting to FinancialForce Sandbox Accounts

Set UseSandbox to true (false by default) to use a FinancialForce sandbox account. Ensure that you specify a sandbox user name in User.

Below is the syntax for a DSN:

[CData FinancialForce Source] Driver = CData ODBC Driver for FinancialForce Description = My Description User = myUser Password = myPassword Security Token = myToken

Execute SQL to FinancialForce

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 FinancialForce};User = myUser;Password = myPassword;Security Token = myToken;') cursor = cnxn.cursor() cursor.execute("SELECT BillingState, Name FROM Account WHERE Industry = 'Floppy Disks'") rows = cursor.fetchall() for row in rows: print(row.BillingState, row.Name)

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