How to connect to Sage 300 Data from IntelliJ

The CData JDBC Driver for Sage 300 enables you to access Sage 300 as a JDBC data source, providing integration with rapid development tools in IDEs. This article shows how to use the data source configuration wizard to connect to Sage 300 data in IntelliJ.

Create a JBDC Data Source for Sage 300

Follow the steps below to add the driver JAR and define connection properties required to connect to Sage 300 data.

1. In the Data Sources window, right-click and then click Add Data Source -> DB Data Source.

2. In the Data Source Properties dialog that appears, the following properties are required:

   • JDBC Driver Files: Click the button next to this menu to add the JDBC Driver file cdata.jdbc.sage300.jar, located in the installation directory.
   • JDBC Driver Class: In this menu, select cdata.jdbc.sage300.Sage300Driver from the list.

   • Database URL: Enter the connection URL in the JDBC URL property. The URL must start with jdbc:sage300: and includes connection properties separated with semicolons.

     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.

     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.

     👁 Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)
     

     A typical JDBC URL is the following:

     jdbc:sage300:User=SAMPLE;Password=password;URL=http://127.0.0.1/Sage300WebApi/v1/-/;Company=SAMINC;

Edit and Save Sage 300 Data

To discover schema information, right-click the data source you just created and click Refresh Tables. To query a table, right-click it and then click Open Tables Editor.