Connect to Sage 300 Data in HULFT Integrate

Ready to get started?

Download for a free trial:

Download Now

Learn more:

Sage 300 JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with Sage 300.



Connect to Sage 300 as a JDBC data source in HULFT Integrate

HULFT Integrate is a modern data integration platform that provides a drag-and-drop user interface to create cooperation flows, data conversion, and processing so that complex data connections are easier than ever to execute. When paired with the CData JDBC Driver for Sage 300, HULFT Integrate can work with live Sage 300 data. This article walks through connecting to Sage 300 and moving the data into a CSV file.

With built-in optimized data processing, the CData JDBC Driver offers unmatched performance for interacting with live Sage 300 data. When you issue complex SQL queries to Sage 300, the driver pushes supported SQL operations, like filters and aggregations, directly to Sage 300 and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations). Its built-in dynamic metadata querying allows you to work with and analyze Sage 300 data using native data types.

Enable Access to Sage 300

To enable access to Sage 300 data from HULFT Integrate projects:

  1. Copy the CData JDBC Driver JAR file (and license file if it exists), cdata.jdbc.sage300.jar (and cdata.jdbc.sage300.lic), to the jdbc_adapter subfolder for the Integrate Server
  2. Restart the HULFT Integrate Server and launch HULFT Integrate Studio

Build a Project with Access to Sage 300 Data

Once you copy the JAR files, you can create a project with access to Sage 300 data. Start by opening Integrate Studio and creating a new project.

  1. Name the project
  2. Ensure the "Create script" checkbox is checked
  3. Click Next
  4. Name the script (e.g.: Sage300toCSV)

Once you create the project, add components to the script to copy Sage 300 data to a CSV file.

Configure an Execute Select SQL Component

Drag an "Execute Select SQL" component from the Tool Palette (Database -> JDBC) into the Script workspace.

  1. In the "Required settings" tab for the Destination, click "Add" to create a new connection for Sage 300. Set the following properties:
    • Name: Sage 300 Connection Settings
    • Driver class name: cdata.jdbc.sage300.Sage300Driver
    • URL: jdbc:sage300:User=SAMPLE;Password=password;URL=http://127.0.0.1/Sage300WebApi/v1/-/;Company=SAMINC;

      Built-in Connection String Designer

      For assistance 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.
  2. Write your SQL statement. For example:
    SELECT InvoiceUniquifier, ApprovedLimit FROM OEInvoices
  3. Click "Extraction test" to ensure the connection and query are configured properly
  4. Click "Execute SQL statement and set output schema"
  5. Click "Finish"

Configure a Write CSV File Component

Drag a "Write CSV File" component from the Tool Palette (File -> CSV) onto the workspace.

  1. Set a file to write the query results to (e.g. OEInvoices.csv)
  2. Set "Input data" to the "Select SQL" component
  3. Add columns for each field selected in the SQL query
  4. In the "Write settings" tab, check the checkbox to "Insert column names into first row"
  5. Click "Finish"

Map Sage 300 Fields to the CSV Columns

Map each column from the "Select" component to the corresponding column for the "CSV" component.

Finish the Script

Drag the "Start" component onto the "Select" component and the "CSV" component onto the "End" component. Build the script and run the script to move Sage 300 data into a CSV file.

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