Connect to Sage 300 Data in Aqua Data Studio

The CData JDBC Driver for Sage 300 integrates Sage 300 data with wizards and analytics in IDEs like Aqua Data Studio. This article shows how to connect to Sage 300 data through the connection manager and execute queries.

Create a JDBC Data Source

You can use the connection manager to define connection properties and save them in a new JDBC data source. The Sage 300 data source can then be accessed from Aqua Data Studio tools.

1. In Aqua Data Studio, select Register Server from the Servers menu.
2. In the Register Server form, select the 'Generic - JDBC' connection.
3. Enter the following JDBC connection properties:
   • Name: Enter a name for the data source; for example, Sage 300.
   • Driver Location: Click the Browse button and select the cdata.jdbc.sage300.jar file, located in the lib subfolder of the installation directory.
   • Driver: Enter the Driver's class name, cdata.jdbc.sage300.Sage300Driver.

   • URL: Enter the JDBC URL, which starts with jdbc:sage300: and is followed by a semicolon-separated list of connection properties.

     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.

     A typical JDBC URL is below:
     jdbc:sage300:User=SAMPLE;Password=password;URL=http://127.0.0.1/Sage300WebApi/v1/-/;Company=SAMINC;

Query Sage 300 Data

You can now query the tables exposed.