Ready to get started?

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

Download Now

Connect to Sage 300 Data in DBVisualizer

Integrate Sage 300 data with visual data analysis tools and data connection wizards in DBVisualizer

The CData JDBC Driver for Sage 300 implements JDBC standards to provide connectivity to Sage 300 data in applications ranging from business intelligence tools to IDEs. This article shows how to establish a connection to Sage 300 data in DBVisualizer and use the table editor to load Sage 300 data.

Create a New JDBC Data Source for Sage 300 Data

Follow the steps below to use the Driver Manager to provide connectivity to Sage 300 data from DBVisualizer tools.

  1. In DBVisualizer, click Tools -> Driver Manager -> Create a New Driver.
  2. Enter a name for the data source.
  3. Enter the following in the URL Format box: jdbc:sage300:
    The DBVisualizer Driver Manager.
  4. In the User Specified tab, click the Open File button and select the cdata.jdbc.sage300.jar file, located in the lib subfolder of the installation directory.
  5. In the Driver Class menu, select the Sage300Driver class, cdata.jdbc.sage300.Sage300Driver.

Define the Connection to the JDBC Data Source

Follow the steps below to save connection properties in the JDBC URL.

  1. In the Database tab, right-click the Database Connection node and click Create a Database Connection.
  2. In the Connection section, set the following options:

    • Database Type: If you selected the wizard option, the database type is automatically detected. If you selected the "No Wizard" option, select the Generic or Auto Detect option in the Database Type menu.
    • Driver: Select the driver you just created.
    • Database URL: Enter the full JDBC URL. The syntax of the JDBC URL is jdbc:sage300: followed by the connection properties in a semicolon-separated list of name-value pairs.

      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.

      When you configure the JDBC URL, you may also want to set the Max Rows connection property. This will limit the number of rows returned, which is especially helpful for improving performance when designing reports and visualizations.

      A typical connection string is below:

      jdbc:sage300:User=SAMPLE;Password=password;URL=http://127.0.0.1/Sage300WebApi/v1/-/;Company=SAMINC;
    • Database UserId: The username to use to authenticate to Sage 300.
    • Database Password: The password to use to authenticate to Sage 300.
  3. On the Connection tab, click Connect.

To browse through tables exposed by the Sage 300 JDBC Driver, right-click a table and click Open in New Tab.

To execute SQL queries, use the SQL Commander tool: Click SQL Commander -> New SQL Commander. Select the Database Connection, Database, and Schema from the available menus.

See the "Supported SQL" chapter in the help documentation for more information on the supported SQL. See the "Data Model" chapter for table-specific information.