Ready to get started?

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

Download Now

Using the CData ODBC Driver for Sage 300 in PyCharm

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

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 Sage 300 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 Sage 300 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 Sage 300

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.

Sage 300 requires some initial setup in order to communicate over the Sage 300 Web API.

  • Set up the security groups for the Sage 300 user. Give the Sage 300 user access to the option under Security Groups (per each module required).
  • Edit both web.config files in the /Online/Web and /Online/WebApi folders; change the key AllowWebApiAccessForAdmin to true. Restart the webAPI app-pool for the settings to take.
  • Once the user access is configured, click https://server/Sage300WebApi/ to ensure access to the web API.

Authenticate to Sage 300 using Basic authentication.

Connect Using Basic Authentication

You must provide values for the following properties to successfully authenticate to Sage 300. Note that the provider reuses the session opened by Sage 300 using cookies. This means that your credentials are used only on the first request to open the session. After that, cookies returned from Sage 300 are used for authentication.

  • Url: Set this to the url of the server hosting Sage 300. Construct a URL for the Sage 300 Web API as follows: {protocol}://{host-application-path}/v{version}/{tenant}/ For example, http://localhost/Sage300WebApi/v1.0/-/.
  • User: Set this to the username of your account.
  • Password: Set this to the password of your account.

Below is the syntax for a DSN:

[CData Sage300 Source] Driver = CData ODBC Driver for Sage 300 Description = My Description User = SAMPLE Password = password URL = http://127.0.0.1/Sage300WebApi/v1/-/ Company = SAMINC

Execute SQL to Sage 300

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 Sage300};User = SAMPLE;Password = password;URL = http://127.0.0.1/Sage300WebApi/v1/-/;Company = SAMINC;') cursor = cnxn.cursor() cursor.execute("SELECT InvoiceUniquifier, ApprovedLimit FROM OEInvoices WHERE AllowPartialShipments = 'Yes'") rows = cursor.fetchall() for row in rows: print(row.InvoiceUniquifier, row.ApprovedLimit)

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