Query Sage 300 Data in DataGrip

DataGrip is a database IDE that allows SQL developers to query, create, and manage databases. When paired with the CData JDBC Driver for Sage 300, DataGrip can work with live Sage 300 data. This article shows how to establish a connection to Sage 300 data in DataGrip.

Create a New Driver Definition for Sage 300

The steps below describe how to create a new Data Source in DataGrip for Sage 300.

1. In DataGrip, click File -> New > Project and name the project
2. In the Database Explorer, click the plus icon () and select Driver.
3. In the Driver tab:
   • Set Name to a user-friendly name (e.g. "CData Sage 300 Driver")
   • Set Driver Files to the appropriate JAR file. To add the file, click the plus (), select "Add Files," navigate to the "lib" folder in the driver's installation directory and select the JAR file (e.g. cdata.jdbc.sage300.jar).
   • Set Class to cdata.jdbc.sage300.Sage300.jar
   Additionally, in the advanced tab you can change driver properties and some other settings like VM Options, VM environment, VM home path, DBMS, etc
   • For most cases, change the DBMS type to "Unknown" in Expert options to avoid native SQL Server queries (Transact-SQL), which might result in an invalid function error
4. Click "Apply" then "OK" to save the Connection

Configure a Connection to Sage 300

1. Once the connection is saved, click the plus (), then "Data Source" then "CData Sage 300 Driver" to create a new Sage 300 Data Source.
2. In the new window, configure the connection to Sage 300 with a JDBC URL.

   Built-in Connection String Designer

   For assistance in constructing the JDBC URL, use the connection string designer built into the Sage 300 JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

   java -jar cdata.jdbc.sage300.jar

   Fill in the connection properties and copy the connection string to the clipboard.

   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.
3. Set URL to the connection string, e.g., jdbc:sage300:User=SAMPLE;Password=password;URL=http://127.0.0.1/Sage300WebApi/v1/-/;Company=SAMINC;
4. Click "Apply" and "OK" to save the connection string

At this point, you will see the data source in the Data Explorer.

Execute SQL Queries Against Sage 300

To browse through the Sage 300 entities (available as tables) accessible through the JDBC Driver, expand the Data Source.

To execute queries, right click on any table and select "New" -> "Query Console."

In the Console, write the SQL query you wish to execute. For example: SELECT InvoiceUniquifier, ApprovedLimit FROM OEInvoices WHERE AllowPartialShipments = 'Yes'

Download a free, 30-day trial of the CData JDBC Driver for Sage 300 and start working with your live Sage 300 data in DataGrip. Reach out to our Support Team if you have any questions.